cascade-cms-rest 2.0.2__tar.gz

cascade_cms_rest-2.0.2/.github/workflows/ci.yml

@@ -0,0 +1,25 @@
+name: CI
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install package
+        run: pip install -e ".[dev]"
+      - name: Lint
+        run: ruff check .
+      - name: Type check
+        run: mypy src/
+      - name: Test
+        run: pytest

cascade_cms_rest-2.0.2/.github/workflows/dependency-review.yml

@@ -0,0 +1,39 @@
+# Dependency Review Action
+#
+# This Action will scan dependency manifest files that change as part of a Pull Request,
+# surfacing known-vulnerable versions of the packages declared or updated in the PR.
+# Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable
+# packages will be blocked from merging.
+#
+# Source repository: https://github.com/actions/dependency-review-action
+# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
+name: 'Dependency review'
+on:
+  pull_request:
+    branches: [ "master" ]
+
+# If using a dependency submission action in this workflow this permission will need to be set to:
+#
+# permissions:
+#   contents: write
+#
+# https://docs.github.com/en/enterprise-cloud@latest/code-security/supply-chain-security/understanding-your-software-supply-chain/using-the-dependency-submission-api
+permissions:
+  contents: read
+  # Write permissions for pull-requests are required for using the `comment-summary-in-pr` option, comment out if you aren't using this option
+  pull-requests: write
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout repository'
+        uses: actions/checkout@v4
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v4
+        # Commonly enabled options, see https://github.com/actions/dependency-review-action#configuration-options for all available options.
+        with:
+          comment-summary-in-pr: always
+        #   fail-on-severity: moderate
+        #   deny-licenses: GPL-1.0-or-later, LGPL-2.0-or-later
+        #   retry-on-snapshot-warnings: true

cascade_cms_rest-2.0.2/.gitignore

@@ -0,0 +1,31 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+
+# Virtual environments
+.venv/
+venv/
+
+# Agents
+.claude/
+CLAUDE.md
+
+# Cache
+cache/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+
+# Environment / secrets
+.env
+
+# Editors
+.vscode/
+.idea/
+
+# OS
+.DS_Store

cascade_cms_rest-2.0.2/CHANGELOG.md

@@ -0,0 +1,29 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [2.0.2]
+
+### Fixed
+- `SimplePayload.format_builder()` now respects field aliases during serialization, so payload subclasses (`copyParameters`, `deleteParameters`, `moveParameters`, `publishInformation`, etc.) emit camelCase keys instead of snake_case.
+- `IdentifierType.identifier` now serializes as a bare 32-char hex string (instead of dashed UUID format) to match Cascade's REST API requirements.
+- `CascadeWrapperBase` constructor was failing with `TypeError` due to `Operations` receiving `logger=` kwarg instead of matching its dataclass field name `_logger=`.
+- Write operations (`edit`, `delete`, `copy`, `move`, `publish`, `checkIn`, `siteCopy`, `editAccessRights`, `markMessage`, `deleteMessage`, `editPreference`, `editWorkflowSettings`, `performWorkflowTransition`) now properly parse and surface bare `{"success": true}` responses instead of silently dropping them.
+
+### Added
+- `Asset.asset_type` public property getter to read the asset type without accessing the private `_asset_type` attribute.
+- `CascadeSuccess` response model and `parse_success` parser for handling success-only responses from write operations.
+
+## [2.0.0]
+
+### Added
+- `Path`-based asset addressing (`IdentifierType | Path`) across all identifier-accepting operations.
+- Dedicated response parsers for `readAccessRights`, `readWorkflowSettings`, `checkOut`, and `readWorkflowInformation`.
+- `performWorkflowTransition` implementation (previously a stub).
+- `src/`-layout packaging via `pyproject.toml` (Hatchling build backend).
+
+### Fixed
+- `readWorkflowInformation` was calling the `readWorkflowSettings` endpoint instead of its own.
+
+### Changed
+- `cmstypes.py` reorganized into clearly separated payload models, response models, type adapters, and parsers.

cascade_cms_rest-2.0.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 py-cascade-cms contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cascade_cms_rest-2.0.2/PACKAGING_ROADMAP.md

@@ -0,0 +1,114 @@
+# Packaging Roadmap: Distributing `cascade_cms` on PyPI
+
+This document lays out the cleanest path from the current repo layout to a publishable PyPI package. Nothing here has been executed — it's a recommendation to work through when the library is ready to ship.
+
+## 1. Target file tree
+
+Move to a `src/`-layout. It forces imports to go through the installed package (not the working directory), which is what actually catches packaging mistakes before a user does.
+
+```
+py-cascade-cms/
+├── pyproject.toml
+├── README.md
+├── LICENSE
+├── CHANGELOG.md
+├── .gitignore
+├── src/
+│   └── cascade_cms/
+│       ├── __init__.py
+│       ├── cmstypes.py
+│       ├── driver.py
+│       ├── operations.py
+│       └── wrapper.py
+├── tests/
+│   ├── conftest.py
+│   ├── test_cmstypes.py
+│   ├── test_operations.py
+│   └── test_driver.py
+├── examples/
+│   └── read_and_update_asset.py       # test_script.py's pattern, cleaned up
+└── .github/
+    └── workflows/
+        └── ci.yml
+```
+
+Changes from today:
+- `cascade_cms/` moves under `src/`.
+- `test_script.py` moves into `examples/` (it's a usage demo, not a test — see §3) with the hardcoded credentials replaced by environment variable reads.
+- `cache/cache.sqlite` stays out of version control (add to `.gitignore` if not already).
+
+## 2. `pyproject.toml`
+
+Recommend **Hatchling** as the build backend — zero-config for a single-package `src/` layout, no `setup.py` needed.
+
+```toml
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "cascade-cms"
+version = "0.1.0"
+description = "A typed, async REST client for Hannon Hill Cascade CMS"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.11"          # uses `Self`, `TypeAlias`, PEP 604 unions
+authors = [{ name = "..." }]
+dependencies = [
+    "aiohttp-client-cache[sqlite]",
+    "python-dotenv",
+    "pydantic>=2",
+]
+
+[project.optional-dependencies]
+dev = ["pytest", "pytest-asyncio", "mypy", "ruff", "build", "twine"]
+
+[project.urls]
+Homepage = "https://github.com/<org>/py-cascade-cms"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/cascade_cms"]
+```
+
+Note the current code already uses `Self` (PEP 673) and `X | Y` unions, so `requires-python` should be pinned to whatever minimum Python version was actually tested (3.11+ recommended; confirm against the `.venv`'s interpreter version).
+
+## 3. Tests vs. examples
+
+There is currently no `tests/` directory — `test_script.py` is a manual, network-hitting demo script (hardcoded API key/URL), not an automated test. For PyPI-quality packaging:
+- Move it to `examples/` and strip the hardcoded credentials in favor of `os.environ` + `python-dotenv`.
+- Add real `tests/` using `pytest` + `pytest-asyncio`, mocking `aiohttp.ClientSession` (e.g. via `aioresponses` or a hand-rolled fake session) so tests don't require a live Cascade instance. Priority coverage: `resolve_identifier` (both `IdentifierType` and `Path` branches), `RequestExecutor.fetch` caching behavior, and the `ResponseParser` CascadeError-vs-success branching.
+
+## 4. Versioning
+
+Start with manual versioning in `pyproject.toml` (`version = "0.1.0"`), bump by hand per release. Once the release cadence is established, consider `hatch-vcs` to derive the version from git tags instead of hand-editing — not necessary for a first release.
+
+## 5. README
+
+Currently there is no `README.md`. It should show the fluent pattern already demonstrated in `test_script.py`/`examples/`:
+```python
+with CascadeWrapperBase(env, config) as cascade:
+    cascade.operations.read(identifier)
+    results = cascade.submit_requests(Asset)
+```
+plus a short note on the `IdentifierType | Path` addressing modes now supported.
+
+## 6. CI
+
+A minimal `.github/workflows/ci.yml` running on push/PR: install `.[dev]`, run `ruff check`, `mypy src/`, `pytest`. Keep it to lint + type-check + test — no publish step in this workflow (see §7).
+
+## 7. Build & publish checklist (manual, not automated here)
+
+1. `python -m build` → produces `dist/*.whl` and `dist/*.tar.gz`.
+2. `twine check dist/*` → validates metadata/README rendering before upload.
+3. Upload to **TestPyPI** first: `twine upload --repository testpypi dist/*`, install in a scratch venv, sanity-check `import cascade_cms`.
+4. Only once TestPyPI install is confirmed clean: `twine upload dist/*` to the real index.
+5. Tag the release in git (`git tag vX.Y.Z`) matching the published version.
+
+Steps 3-5 involve publishing to a shared, effectively irreversible public index — do these manually and deliberately, not as part of an automated agent run.
+
+## Summary of concrete next actions
+1. Add `pyproject.toml` (§2), remove `requirements.txt` once dependencies are captured there.
+2. Restructure into `src/cascade_cms/` (§1).
+3. Add `tests/` with mocked HTTP (§3); keep `test_script.py`'s pattern alive as `examples/`.
+4. Add `README.md`, `LICENSE`, `.gitignore`, CI workflow (§5, §6).
+5. Only then proceed to the manual build/publish checklist (§7).

cascade_cms_rest-2.0.2/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: cascade-cms-rest
+Version: 2.0.2
+Summary: A typed, async REST client for Hannon Hill Cascade CMS
+Project-URL: Homepage, https://github.com/Sharkdroid/py-cascade-cms
+Author: ...
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: aiohttp-client-cache[sqlite]
+Requires-Dist: pydantic>=2
+Requires-Dist: python-dotenv
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-asyncio; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# cascade-cms
+
+A typed, async REST client for Hannon Hill Cascade CMS.
+
+[Full Documentation](https://sharkdroid.github.io/wiki/cascade-cms-wiki/)
+
+## Usage
+
+```python
+from cascade_cms.cmstypes import Asset, IdentifierType
+from cascade_cms.wrapper import CascadeWrapperBase
+
+environment_variables = {
+    "API_KEY": "...",
+    "CASCADE_URL": "...",
+    "SERVER": "prod",  # label used for logfile naming
+}
+configuration_variables = {
+    "cache_name": "./cache/cache.sqlite",
+    "allowed_codes": (200,),
+    "allowed_methods": ("GET",),
+}
+
+with CascadeWrapperBase(environment_variables, configuration_variables) as cascade:
+    identifier = IdentifierType(identifier="e868f539ac1001062cfa029c4c5df4d0", asset_type="folder")
+    cascade.operations.read(identifier)
+    results = cascade.submit_requests(Asset)
+```
+
+Operations that take an identifier (`read`, `delete`, `copy`, `move`, `publish`, `checkIn`, `checkOut`,
+`listSubscribers`, `readAccessRights`, `readWorkflowSettings`, `readWorkflowInformation`,
+`performWorkflowTransition`) accept either an `IdentifierType` (asset type + UUID) or a `Path`
+(asset type + site name + site-relative path) — see `cascade_cms.cmstypes.resolve_identifier`.
+
+See `examples/read_and_update_asset.py` for a fuller walkthrough.
+
+### Logging
+
+`CascadeWrapperBase` accepts an optional third `debug` argument. Leaving it as `None`
+(the default) runs in **normal mode**: a minimal console (`[INIT]`/`[RUNNING]`/`Processed: n/N`/
+`[DONE]`/`[EXIT]`) plus a simple logfile at `./logs/{SERVER}_{timestamp}.log`. Passing a dict
+switches to **debug mode**: a quiet console and a verbose, nested logfile at
+`./logs/{SERVER}_debug_{timestamp}.log` describing every request, response, callback, and error.
+
+```python
+debug_config = {
+    "log_dir": "./logs",
+    "log_operations": True,
+    "log_callbacks": True,
+    "log_responses": True,
+    "show_payload_data": True,
+    "show_network_headers": False,
+    "show_error_variables": True,
+    "response_line_limit": 8,   # -1 = dump full response body
+}
+
+with CascadeWrapperBase(environment_variables, configuration_variables, debug=debug_config) as cascade:
+    ...
+```
+
+All keys are required in debug mode — there are no inferred defaults, so you always know what
+you opted into.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+```

cascade_cms_rest-2.0.2/README.md

@@ -0,0 +1,69 @@
+# cascade-cms
+
+A typed, async REST client for Hannon Hill Cascade CMS.
+
+[Full Documentation](https://sharkdroid.github.io/wiki/cascade-cms-wiki/)
+
+## Usage
+
+```python
+from cascade_cms.cmstypes import Asset, IdentifierType
+from cascade_cms.wrapper import CascadeWrapperBase
+
+environment_variables = {
+    "API_KEY": "...",
+    "CASCADE_URL": "...",
+    "SERVER": "prod",  # label used for logfile naming
+}
+configuration_variables = {
+    "cache_name": "./cache/cache.sqlite",
+    "allowed_codes": (200,),
+    "allowed_methods": ("GET",),
+}
+
+with CascadeWrapperBase(environment_variables, configuration_variables) as cascade:
+    identifier = IdentifierType(identifier="e868f539ac1001062cfa029c4c5df4d0", asset_type="folder")
+    cascade.operations.read(identifier)
+    results = cascade.submit_requests(Asset)
+```
+
+Operations that take an identifier (`read`, `delete`, `copy`, `move`, `publish`, `checkIn`, `checkOut`,
+`listSubscribers`, `readAccessRights`, `readWorkflowSettings`, `readWorkflowInformation`,
+`performWorkflowTransition`) accept either an `IdentifierType` (asset type + UUID) or a `Path`
+(asset type + site name + site-relative path) — see `cascade_cms.cmstypes.resolve_identifier`.
+
+See `examples/read_and_update_asset.py` for a fuller walkthrough.
+
+### Logging
+
+`CascadeWrapperBase` accepts an optional third `debug` argument. Leaving it as `None`
+(the default) runs in **normal mode**: a minimal console (`[INIT]`/`[RUNNING]`/`Processed: n/N`/
+`[DONE]`/`[EXIT]`) plus a simple logfile at `./logs/{SERVER}_{timestamp}.log`. Passing a dict
+switches to **debug mode**: a quiet console and a verbose, nested logfile at
+`./logs/{SERVER}_debug_{timestamp}.log` describing every request, response, callback, and error.
+
+```python
+debug_config = {
+    "log_dir": "./logs",
+    "log_operations": True,
+    "log_callbacks": True,
+    "log_responses": True,
+    "show_payload_data": True,
+    "show_network_headers": False,
+    "show_error_variables": True,
+    "response_line_limit": 8,   # -1 = dump full response body
+}
+
+with CascadeWrapperBase(environment_variables, configuration_variables, debug=debug_config) as cascade:
+    ...
+```
+
+All keys are required in debug mode — there are no inferred defaults, so you always know what
+you opted into.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+```

cascade_cms_rest-2.0.2/pyproject.toml

@@ -0,0 +1,26 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "cascade-cms-rest"
+version = "2.0.2"
+description = "A typed, async REST client for Hannon Hill Cascade CMS"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.11"          # uses `Self`, `TypeAlias`, PEP 604 unions
+authors = [{ name = "..." }]
+dependencies = [
+    "aiohttp-client-cache[sqlite]",
+    "python-dotenv",
+    "pydantic>=2",
+]
+
+[project.optional-dependencies]
+dev = ["pytest", "pytest-asyncio", "mypy", "ruff", "build", "twine"]
+
+[project.urls]
+Homepage = "https://github.com/Sharkdroid/py-cascade-cms"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/cascade_cms"]

cascade_cms_rest-2.0.2/src/cascade_cms/__init__.py

@@ -0,0 +1,6 @@
+"""Cascade CMS REST API client library.
+
+Provides an async REST driver, a fluent Operations builder for queuing
+Cascade CMS requests, Pydantic-based payload/response models, and an
+OperationLogger for console/logfile output.
+"""