Skip to main content

Cascade CMS 8 REST API Python Driver

This is a module for simplifying interaction with Hannon Hill's Cascade CMS 8 REST API. This was built to handle some day-to-day task automation with Cascade CMS 8, e.g., access control management, workflow management, file naming rule enforcement, and more.

How it Works

The driver class CascadeCMSRestDriver constructor accepts either a username and password combination or a user-specific API key (i.e., for a service account in Cascade CMS) in addition to an organization name, e.g. "cofc". From there, it uses these values to create some headers that are used in combination with the requests library to wrap requests against the Cascade CMS REST API in simple methods, like list_sites. The methods are based on the API's WSDL description. (Replace my-org in the previous link with your own organization).

Installation

To install the package, simply run:

pip install py-cascade-cms-api

Usage

# import
from cascadecmsdriver.driver import CascadeCMSRestDriver

# you can provide a username and password or alternatively an api key
# verbose boolean indicates whether to use verbose logging
driver = CascadeCMSRestDriver(
    organization_name="my-org", api_key='my-api-key', verbose=True)
## driver = CascadeCMSRestDriver(
##    organization_name="my-org", username='my-username', password='my-password',
##    verbose=True)
##
sites = driver.list_sites()['sites']
for s in sites:
    asset = driver.read_asset(asset_type='site', asset_identifier=s['id'])
    driver.debug(asset)

Release files for py-cascade-cms-api 1.1.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for py-cascade-cms-api 1.1.3
File Size Uploaded
py-cascade-cms-api-1.1.3.tar.gz 15.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for py-cascade-cms-api 1.1.3
File Interpreter ABI Platform
py_cascade_cms_api-1.1.3-py3-none-any.whl Python 3 none any Details

Total release size: 29.8 kB

Release files / py-cascade-cms-api-1.1.3.tar.gz

Download URL py-cascade-cms-api-1.1.3.tar.gz
Size 15.1 kB
Tags Source
SHA-256 checksum
How to use checksums
bede01aa2ffb66b13fe618f1bcb3fe05db08d30316fcd1b159642724a7991663
BLAKE2b-256 checksum
How to use checksums
1d9aeb5a122fc9818f1623db370c7e9a270695083a2e61ea55b167f88aa8ff11
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.10.1

Release files / py_cascade_cms_api-1.1.3-py3-none-any.whl

Download URL py_cascade_cms_api-1.1.3-py3-none-any.whl
Size 14.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9c14808eb60e58a21ab11d9f01280310d8aedcdf69674b96d21b903504e81a17
BLAKE2b-256 checksum
How to use checksums
76e4786b446563a946d913845fec5fa43b3e6a1b830a58c7492fa3441f0eda2f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.0 CPython/3.10.1

Release history Release notifications | RSS feed

This release

1.1.3 This release

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release 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