Merge pull request #16 from pnnl/main

sync develop

Author: yanyanzhu-pnnl

.github/workflows/docs.yml

@@ -1,9 +1,13 @@
 name: Deploy Documentation
 
+# Docs deploy only when a public version ships: after the "Publish to PyPI"
+# workflow finishes successfully, or on a manual run. Routine pushes to main
+# (and work on develop) do NOT update the public site.
 on:
-  push:
-    branches:
-      - main
+  workflow_run:
+    workflows: ["Publish to PyPI"]
+    types: [completed]
+  workflow_dispatch:        # allow manual rebuilds
 
 permissions:
   contents: read
@@ -17,11 +21,15 @@ concurrency:
 jobs:
   build:
     runs-on: ubuntu-latest
+    # Only build on a successful publish, or when triggered manually.
+    if: >
+      github.event_name == 'workflow_dispatch'
+      || github.event.workflow_run.conclusion == 'success'
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v8.2.0
 
       - name: Set up Python
         run: uv python install 3.12
@@ -33,7 +41,7 @@ jobs:
         run: uv run mkdocs build
 
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v3
+        uses: actions/upload-pages-artifact@v5
         with:
           path: site
 
@@ -42,8 +50,10 @@ jobs:
     runs-on: ubuntu-latest
     environment:
       name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
+      # Canonical public URL; deploy-pages' page_url output reports GitHub's
+      # internal *.pages.github.io alias for org repos, so hardcode it.
+      url: https://pnnl.github.io/comcheckweb-api-python/
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v4
+        uses: actions/deploy-pages@v5

.github/workflows/publish.yml

@@ -15,10 +15,10 @@ jobs:
     runs-on: ubuntu-latest
     environment: pypi
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
 
       - name: Install uv
-        uses: astral-sh/setup-uv@v4
+        uses: astral-sh/setup-uv@v8.2.0
 
       - name: Set version (if provided)
         if: ${{ inputs.version != '' }}

.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: Tests
+
+# Run the offline test suite on every PR into main or develop (and on pushes
+# to those branches). Live API tests skip automatically without a key.
+on:
+  pull_request:
+    branches:
+      - main
+      - develop
+  push:
+    branches:
+      - main
+      - develop
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.2.0
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Run tests
+        run: uv run pytest -q

CHANGELOG.md

@@ -145,6 +145,32 @@ Pass `--global` to install into the user-global skills dirs
 (`~/.claude/skills/` and/or `~/.agents/skills/`) for every session
 instead of per-project.
 
+## Support
+
+This is a publicly available library maintained by PNNL. While the code is open source and free to use, **external contributions are not accepted** at this time.
+
+### Reporting Issues
+
+If you encounter bugs or have questions:
+- Open an issue on GitHub for bug reports
+- Check the [examples/](examples/) directory for usage guidance
+- Review the [documentation](https://pnnl.github.io/comcheckweb-api-python/) for detailed information
+
+**Note:** Issues are welcome, but pull requests from external contributors will not be accepted.
+
+## License
+
+See the `LICENSE` file at the repository root for license details.
+
+See the [`DISCLAIMER.md`](DISCLAIMER.md) file for the warranty and
+liability disclaimer.
+
+---
+
+> **Note:** The sections below are for the PNNL team that maintains this
+> package. External contributions and pull requests are not accepted, so
+> this tooling is not required to *use* the published package.
+
 ## Development
 
 Clone the repository and follow the commands below to set up developer tooling.
@@ -197,20 +223,3 @@ uv run mkdocs build
 # Fail on warnings (good before committing)
 uv run mkdocs build --strict
 ```
-
-## Support
-
-This is a publicly available library maintained by PNNL. While the code is open source and free to use, **external contributions are not accepted** at this time.
-
-### Reporting Issues
-
-If you encounter bugs or have questions:
-- Open an issue on GitHub for bug reports
-- Check the [examples/](examples/) directory for usage guidance
-- Review the [documentation](docs/) for detailed information
-
-**Note:** Issues are welcome, but pull requests from external contributors will not be accepted.
-
-## License
-
-See the `LICENSE` file at the repository root for license details.

README.md

@@ -10,9 +10,6 @@ examples/
 ├── client/                           # API client examples
 │   ├── simulation.py                 # Simulation API workflow examples
 │   └── user_functions.py             # User-facing function examples
-├── data_manager/                     # Data manager examples
-│   ├── building_area.py             # Building area manager examples
-│   └── envelope.py                  # Envelope manager examples
 └── project_operations/               # Project operations examples
     ├── building_area_operations.py  # Building area operations
     └── envelope_operations.py       # Envelope operations
@@ -51,36 +48,7 @@ python examples/client/user_functions.py
 
 ---
 
-### 2. Data Manager Examples (`data_manager/`)
-Examples demonstrating data manager functionality.
-
-#### Building Area Manager (`data_manager/building_area.py`)
-Examples for building area manager operations.
-
-**What it demonstrates:**
-- Building area list management
-- Building area data operations
-
-**Usage:**
-```bash
-python examples/data_manager/building_area.py
-```
-
-#### Envelope Manager (`data_manager/envelope.py`)
-Examples for envelope component management.
-
-**What it demonstrates:**
-- Envelope component list management
-- Envelope data operations
-
-**Usage:**
-```bash
-python examples/data_manager/envelope.py
-```
-
----
-
-### 3. Project Operations Examples (`project_operations/`)
+### 2. Project Operations Examples (`project_operations/`)
 Examples demonstrating project operations.
 
 #### Building Area Operations (`project_operations/building_area_operations.py`)
@@ -123,9 +91,8 @@ Creates JSON snapshots in `testProjectJson/` directory showing project state aft
 ## Best Practices
 
 1. **Start with client examples** (`client/`) to understand basic API operations
-2. **Explore data manager examples** (`data_manager/`) to learn about data management
-3. **Use project operations examples** (`project_operations/`) for end-to-end workflows
-4. **Check example output** in `testProjectJson/` to understand the results
+2. **Use project operations examples** (`project_operations/`) for end-to-end workflows
+3. **Check example output** in `testProjectJson/` to understand the results
 
 ---
 

examples/README.md

@@ -2,7 +2,7 @@
 
 Automated test suite for the COMcheck API Python client using pytest.
 
-For ad-hoc manual testing during development, see the [scripts/](../scripts/) directory.
+For ad-hoc manual testing during development, see the [tools/scripts/](../tools/scripts/) directory.
 
 ## Directory Structure