cascade-cms

A typed, async REST client for Hannon Hill Cascade CMS.

Full Documentation

Usage

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.

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

pip install -e ".[dev]"
pytest

Project links

Data verified by PyPI on Aug 4, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (3.1.3)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for Sharkbits from gravatar.com Sharkbits

Credits

Author: Keith Shark

GitHub Statistics

Data verified by PyPI on Aug 4, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python >=3.11

Provides Extra

dev

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cascade_cms_rest-2.0.3.tar.gz (25.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cascade_cms_rest-2.0.3-py3-none-any.whl (25.7 kB view details)

Uploaded Python 3

File details

Details for the file cascade_cms_rest-2.0.3.tar.gz.

File metadata

  • Download URL: cascade_cms_rest-2.0.3.tar.gz
  • Upload date:
  • Size: 25.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for cascade_cms_rest-2.0.3.tar.gz
Algorithm Hash digest
SHA256 271804fa8d41da49bf6d21863f42cc6c4f0d4f3673181edae55aac9a520ed61e
MD5 831da8541549c903a45de316fccb26b6
BLAKE2b-256 3c45d1585f05d53bd2292baf78df2242c44f25b4d7a027f233f0608930385b24

See more details on using hashes here.

Provenance

The following attestation bundles were made for cascade_cms_rest-2.0.3.tar.gz:

Publisher: release.yml on Sharkdroid/py-cascade-cms

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file cascade_cms_rest-2.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for cascade_cms_rest-2.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 dae10cebc6d6ac690074fb29c9bd1ac2d1e47521aeafb13748677a00e50fdc1e
MD5 ed42b967b8057d15857aa0268bebe9e2
BLAKE2b-256 09c5239b4b9621391b2cbbe8e1c39500362f79e318931b0e59eae201070cb6f1

See more details on using hashes here.

Provenance

The following attestation bundles were made for cascade_cms_rest-2.0.3-py3-none-any.whl:

Publisher: release.yml on Sharkdroid/py-cascade-cms

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

3.1.3

2 files

3.1.1

2 files

Yanked

3.0.2

2 files

Yanked reason: Depracated: Unintentional upload fixed build version for compatability (https://github.com/Sharkdroid/py-cascade-cms)

3.0.1

2 files

3.0.0

2 files

This release

2.0.3 This release

2 files

2.0.2

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page