Merge pull request #4 from gtri/name-change-update

Name change update

.github/workflows/documentation.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Install dependencies
         run: pip install .[docs]
       - name: Build autodocs
-        run: sphinx-apidoc -o ./docs/source ./src/upstage ./src/upstage/test
+        run: sphinx-apidoc -o ./docs/source ./src/upstage_des ./src/upstage_des/test
       - name: Sphinx build
         run: sphinx-build -b html docs/source _build
       - name: Deploy to GitHub Pages

.github/workflows/lint.yml

@@ -24,4 +24,4 @@ jobs:
     - name: Run Ruff linter
       run: ruff check --output-format=github src
     - name: Run mypy
-      run: mypy --show-error-codes -p upstage
+      run: mypy --show-error-codes -p upstage_des

.github/workflows/publish-to-pypi.yml

@@ -36,7 +36,7 @@ jobs:
     runs-on: ubuntu-latest
     environment:
       name: pypi
-      url: https://pypi.org/p/upstage-des  # Replace <package-name> with your PyPI project name
+      url: https://pypi.org/p/upstage-des 
     permissions:
       id-token: write  # IMPORTANT: mandatory for trusted publishing
 

CONTRIBUTING.md

@@ -32,7 +32,7 @@ python -m pip install --upgrade pip
 Next, clone the repo locally:
 
 ```bash
-cd /path/to/upstage_dev
+cd /path/to/upstage_des
 git clone https://github.com/gtri/upstage.git
 cd upstage
 ```
@@ -64,12 +64,12 @@ pyproject-fmt pyproject.toml
 ssort src
 ruff format src
 ruff check --fix src
-mypy --show-error-codes -p upstage
+mypy --show-error-codes -p upstage_des
 ```
 
 ### Testing
 
-To run the unit tests in `src/upstage/test`, run:
+To run the unit tests in `src/upstage_des/test`, run:
 
 ```bash
 pytest
@@ -86,7 +86,7 @@ Documentation is built from autodocs first, then the source build.
 From the top level of the repo:
 
 ```bash
-sphinx-apidoc -o ./docs/source ./src/upstage ./src/upstage/test
+sphinx-apidoc -o ./docs/source ./src/upstage_des ./src/upstage_des/test
 sphinx-build -b html ./docs/source ./build/docs
 ```
 

docs/source/conf.py

@@ -7,17 +7,17 @@
 
 from datetime import datetime
 
-import upstage
+import upstage_des
 
 sys.path.insert(0, os.path.abspath("../../src"))
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/mast er/usage/configuration.html#project-information
 
 project = "UPSTAGE"
-copyright = f"{datetime.now().year}, {upstage.__authors__}"
-author = upstage.__authors__
-release = upstage.__version__
+copyright = f"{datetime.now().year}, {upstage_des.__authors__}"
+author = upstage_des.__authors__
+release = upstage_des.__version__
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -42,19 +42,19 @@
 myst_heading_anchors = 2
 myst_substitutions = {
     "rtd": "[Read the Docs](https://readthedocs.org/)",
-    "Actor": "{py:class}`Actor <upstage.actor.Actor>`",
-    "State": "{py:class}`~upstage.states.State`",
-    "Task": "{py:class}`~upstage.task.Task`",
-    "TaskNetwork": "{py:class}`~upstage.task_network.TaskNetwork`",
-    "EnvironmentContext": "{py:class}`~upstage.base.EnvironmentContext`",
-    "UpstageBase": "{py:class}`~upstage.base.UpstageBase`",
-    "NamedEntity": "{py:class}`~upstage.base.NamedUpstageEntity`",
-    "LinearChangingState": "{py:class}`~upstage.states.LinearChangingState`",
-    "CartesianLocation": "{py:class}`~upstage.data_types.CartesianLocation`",
-    "GeodeticLocationChangingState": "{py:class}`~upstage.states.GeodeticLocationChangingState`",
-    "ResourceState": "{py:class}`~upstage.states.ResourceState`",
-    "SelfMonitoringStore": "{py:class}`~upstage.stores.SelfMonitoringStore`",
-    "DecisionTask": "{py:class}`~upstage.task.DecisionTask`",
+    "Actor": "{py:class}`Actor <upstage_des.actor.Actor>`",
+    "State": "{py:class}`~upstage_des.states.State`",
+    "Task": "{py:class}`~upstage_des.task.Task`",
+    "TaskNetwork": "{py:class}`~upstage_des.task_network.TaskNetwork`",
+    "EnvironmentContext": "{py:class}`~upstage_des.base.EnvironmentContext`",
+    "UpstageBase": "{py:class}`~upstage_des.base.UpstageBase`",
+    "NamedEntity": "{py:class}`~upstage_des.base.NamedUpstageEntity`",
+    "LinearChangingState": "{py:class}`~upstage_des.states.LinearChangingState`",
+    "CartesianLocation": "{py:class}`~upstage_des.data_types.CartesianLocation`",
+    "GeodeticLocationChangingState": "{py:class}`~upstage_des.states.GeodeticLocationChangingState`",
+    "ResourceState": "{py:class}`~upstage_des.states.ResourceState`",
+    "SelfMonitoringStore": "{py:class}`~upstage_des.stores.SelfMonitoringStore`",
+    "DecisionTask": "{py:class}`~upstage_des.task.DecisionTask`",
 }
 
 

docs/source/index.md

@@ -52,7 +52,7 @@ Alternatively, you can download UPSTAGE and install it manually. Clone, or downl
 Note that the tests include the two full examples from the documentation.
 
 ```console
-(venv) $ pip install uptage[test]
+(venv) $ pip install upstage-des[test]
 (venv) $ pytest
 ```
 
@@ -61,8 +61,8 @@ Note that the tests include the two full examples from the documentation.
 Unless you're adding to the codebase, you won't need to run the `sphinx-apidoc` command.
 
 ```console
-(venv) $ pip install upstage[docs]
-(venv) $ sphinx-apidoc -o .\docs\source\ .\src\upstage\ .\src\upstage\test\
+(venv) $ pip install upstage-des[docs]
+(venv) $ sphinx-apidoc -o .\docs\source\ .\src\upstage_des\ .\src\upstage_des\test\
 (venv) $ sphinx-build -b html .\docs\source\ .\docs\build\
 ```
 

docs/source/modules.rst

@@ -4,4 +4,4 @@ UPSTAGE API
 .. toctree::
    :maxdepth: 3
 
-   upstage
+   upstage_des