#7 Change app name - running just fine

CONTRIBUTING.md

@@ -1,49 +1,49 @@
-# Contributing to qsui
+# Contributing to queueUI
 
-If you are interested in contributing to qsui, your contributions will fall into two categories:
+If you are interested in contributing to queueUI, your contributions will fall into two categories:
 
 1. You want to implement a new feature:
     - In general, we accept any features as long as they fit the scope of this package. If you are unsure about this or need help on the design/implementation of your feature, post about it in an issue.
 2. You want to fix a bug:
     - Please post an issue using the Bug template which provides a clear and concise description of what the bug was.
 
-Once you finish implementing a feature or bug-fix, please send a Pull Request to https://github.com/bcda-APS/qsui.
+Once you finish implementing a feature or bug-fix, please send a Pull Request to https://github.com/bcda-APS/queueUI.
 
-## Developing qsui
+## Developing queueUI
 
-To develop qsui on your machine, please follow these instructions:
+To develop queueUI on your machine, please follow these instructions:
 
-1. Clone a copy of qsui from source:
+1. Clone a copy of queueUI from source:
 
 ```
-git clone https://github.com/bcda-APS/qsui.git
-cd qsui
+git clone https://github.com/bcda-APS/queueUI.git
+cd queueUI
 ```
 
-2. If you already have qsui from source, update it:
+2. If you already have queueUI from source, update it:
 
 ```
 git pull
 ```
 
-3. Install qsui in `develop` mode:
+3. Install queueUI in `develop` mode:
 
 ```
-conda create -n rpl-qsui python=3.9
-conda activate rpl-qsui
+conda create -n rpl-queueUI python=3.9
+conda activate rpl-queueUI
 pip3 install --upgrade pip setuptools wheel
 pip3 install -r requirements/dev.txt
 pip3 install -r requirements/requirements.txt
 pip3 install -e .
 ```
 
 This mode will symlink the Python files from the current local source tree into the Python install.
-Hence, if you modify a Python file, you do not need to reinstall qsui again and again.
+Hence, if you modify a Python file, you do not need to reinstall queueUI again and again.
 
-4. Ensure that you have a working `qsui` installation by running:
+4. Ensure that you have a working `queueUI` installation by running:
 
 ```
-python3 -c "import qsui; print(qsui.__version__)"
+python3 -c "import queueUI; print(queueUI.__version__)"
 ```
 
 5. To run dev tools (isort, flake8, black):
@@ -56,36 +56,36 @@ make
 
 To run the test suite:
 
-1. [Build and install](#developing-qsui) qsui from source.
+1. [Build and install](#developing-queueUI) queueUI from source.
 2. The `requirements/dev.txt` contains the additional testing dependencies.
 3. Run the test suite: `pytest test -vs`
 
 If contributing, please add a `test_<module_name>.py` in the `test/` directory
-in a subdirectory that matches the qsui package directory structure. Inside,
+in a subdirectory that matches the queueUI package directory structure. Inside,
 `test_<module_name>.py` implement test functions using pytest.
 
 ## Building Documentation
 
 To build the documentation:
 
-1. [Build and install](#developing-qsui) qsui from source.
+1. [Build and install](#developing-queueUI) queueUI from source.
 2. The `requirements/dev.txt` contains all the dependencies needed to build the documentation.
 3. Generate the documentation file via:
 ```
-cd qsui/docs
+cd queueUI/docs
 make html
 ```
-The docs are located in `qsui/docs/build/html/index.html`.
+The docs are located in `queueUI/docs/build/html/index.html`.
 
-To view the docs run: `open qsui/docs/build/html/index.html`.
+To view the docs run: `open queueUI/docs/build/html/index.html`.
 
 ## Releasing to PyPI
 
-To release a new version of qsui to PyPI:
+To release a new version of queueUI to PyPI:
 
-1. Merge the `develop` branch into the `main` branch with an updated version number in [`qsui.__init__`](https://github.com/bcda-APS/qsui/blob/main/src/qsui/__init__.py).
+1. Merge the `develop` branch into the `main` branch with an updated version number in [`queueUI.__init__`](https://github.com/bcda-APS/queueUI/blob/main/src/queueUI/__init__.py).
 2. Make a new release on GitHub with the tag and name equal to the version number.
-3. [Build and install](#developing-qsui) qsui from source.
+3. [Build and install](#developing-queueUI) queueUI from source.
 4. Run the following commands:
 ```
 python3 setup.py sdist

LICENSE.txt

@@ -2,7 +2,7 @@ Copyright (c) 2017-2024, UChicago Argonne, LLC
 
 All Rights Reserved
 
-qsui
+queueUI
 
 BCDA, Advanced Photon Source, Argonne National Laboratory
 

README.md

@@ -1,7 +1,7 @@
-# QSUI
+# queueUI
 
 ## Table of Contents
-- [QSUI](#QSUI)
+- [queueUI](#queueUI)
   - [Table of Contents](#table-of-contents)
   - [Usage](#usage)
   - [Installation](#installation)
@@ -14,16 +14,16 @@
 On a terminal:
 ```bash
 git clone https://github.com/BCDA-APS/queueUI.git
-cd qsui
-conda env create --force -n qsui -f ./env.yml
-conda activate qsui
+cd queueUI
+conda env create --force -n queueUI -f ./env.yml
+conda activate queueUI
 pip install -e . --no-deps
 ```
 ## Usage
 On a terminal:
 ```bash
-conda activate qsui
-qsui &
+conda activate queueUI
+queueUI &
 ```
 
 ### Using Pre-commit
@@ -37,9 +37,9 @@ qsui &
 
 ## Contributing
 
-Please report **bugs**, **enhancement requests**, or **questions** through the [Issue Tracker](https://github.com/bcda-APS/qsui).
+Please report **bugs**, **enhancement requests**, or **questions** through the [Issue Tracker](https://github.com/bcda-APS/queueUI).
 
-If you are looking to contribute, please see [`CONTRIBUTING.md`](https://github.com/bcda-APS/qsui/blob/main/CONTRIBUTING.md).
+If you are looking to contribute, please see [`CONTRIBUTING.md`](https://github.com/bcda-APS/queueUI/blob/main/CONTRIBUTING.md).
 
 
 ## Citing
@@ -49,4 +49,4 @@ If you are looking to contribute, please see [`CONTRIBUTING.md`](https://github.
 
 ## License
 
-QSUI is MIT licensed, as seen in the [LICENSE](./LICENSE) file.
+queueUI is MIT licensed, as seen in the [LICENSE](./LICENSE) file.

env.yml

@@ -1,4 +1,4 @@
-name: qsui
+name: queueUI
 
 channels:
   - conda-forge

pyproject.toml

@@ -1,5 +1,5 @@
 [project]
-name = "qsui"
+name = "queueUI"
 version = "0.1.0"
 description = "Default template for PDM package"
 authors = [
@@ -15,18 +15,18 @@ dependencies = [
 ]
 
 [project.scripts]
-qsui = "qsui.app:main"
+queueUI = "queueUI.app:main"
 
 [project.urls]
-Homepage = "https://github.com/bcda-APS/qsui"
-Downloads = "https://github.com/bcda-APS/qsui"
+Homepage = "https://github.com/bcda-APS/queueUI"
+Downloads = "https://github.com/bcda-APS/queueUI"
 
 ######################
 # Build Info + Tools #
 ######################
 
 [tool.setuptools]
-package-dir = {"qsui" = "qsui"}
+package-dir = {"queueUI" = "queueUI"}
 
 #####################
 # Development Tools #

qsui/__init__.py → queueUI/__init__.py

@@ -5,7 +5,7 @@
 import pathlib
 
 __settings_orgName__ = "BCDA-APS"
-__package_name__ = "qsui"
+__package_name__ = "queueUI"
 __version__ = (
     "0.0.1"  # extract_version(Path(__file__).parent.parent / "pyproject.toml")
 )
@@ -28,7 +28,7 @@
 ]
 
 COPYRIGHT_TEXT = "(c) 2023, UChicago Argonne, LLC, (see LICENSE file for details)"
-DOCS_URL = "https://github.com/BCDA-APS/qsui/blob/main/README.md"
-ISSUES_URL = "https://github.com/BCDA-APS/qsui/issues"
+DOCS_URL = "https://github.com/BCDA-APS/queueUI/blob/main/README.md"
+ISSUES_URL = "https://github.com/BCDA-APS/queueUI/issues"
 LICENSE_FILE = "LICENSE.txt"
 VERSION = __version__

qsui/licensedialog.py → queueUI/licensedialog.py

@@ -6,6 +6,8 @@
     ~LicenseDialog
 """
 
+import pathlib
+
 from PyQt5 import QtWidgets
 
 from . import utils
@@ -23,7 +25,7 @@ def __init__(self, parent):
         super().__init__(parent)
         utils.myLoadUi(self.ui_file, baseinstance=self)
 
-        LICENSE_FILE = "../LICENSE.txt"
+        LICENSE_FILE = pathlib.Path(__file__).parent / "../LICENSE.txt"
         self.setModal(True)
         license_text = open(LICENSE_FILE, "r").read()
         self.license.setText(license_text)

tests/__init__.py

@@ -1 +1 @@
-"""Pytest tests for QSUI"""
+"""Pytest tests for queueUI"""