Skip to main content

cwms-cli

A collection of scripts to create, read, update, list, and delete data through CWMS Data API (CDA) and other commonly used API in the US Army Corps of Engineers water management. CWMS-CLI wraps these API in a friendly to use terminal based interface.

Docs - 📖 Read the docs: https://cwms-cli.readthedocs.io/en/latest/

Install

pip install cwms-cli

Note: You may need to run python -m pip install cwms-cli if PIP is not in your path.

Update

python -m pip install --upgrade cwms-cli

Or as of version 0.3.0+

cwms-cli update

cwms-cli update displays the Python executable, environment, package metadata location, and editable project location when applicable before asking for confirmation. It runs pip through the same Python interpreter that is running cwms-cli, avoiding accidental updates to a different Python installation or virtual environment.

To install a specific version:

cwms-cli update --target-version 0.7.1 --yes

Command line implementation

View the help in terminal:

cwms-cli --help

run from within python

from cwmscli.usgs.getusgs_cda import getusgs_cda
from cwmscli.usgs.getusgs_measurements_cda import getusgs_measurements_cda
from cwmscli.usgs.getUSGS_ratings_cda import getusgs_rating_cda

Development environment

The repository includes a Linux/Python 3.12 development container exercised by a dedicated CI job. Open the repository with the VS Code Dev Containers extension, or use the Dev Container CLI:

devcontainer up --workspace-folder .
devcontainer exec --workspace-folder . poetry run pytest -q

The container installs project dependencies with Poetry and uses /home/vscode/.venv, so it does not reuse a host operating system's .venv. Poetry itself is kept in a separate /opt/poetry environment. The workspace root is also added to PYTHONPATH, so the checked-out source and local test modules are available throughout a Codespace without copying them into the image. Use the container for changes involving time zones, paths, native libraries, or other operating-system-dependent behavior. Standard Python 3.9 and Python 3.12 installations remain covered by the existing CI matrix.

Metadata

Release files for cwms-cli 0.9.1

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

Source distribution (sdist)

Source distribution for cwms-cli 0.9.1
File Size Uploaded
cwms_cli-0.9.1.tar.gz 113.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for cwms-cli 0.9.1
File Interpreter ABI Platform
cwms_cli-0.9.1-py3-none-any.whl Python 3 none any Details

Total release size: 257.4 kB

Release files / cwms_cli-0.9.1.tar.gz

Download URL cwms_cli-0.9.1.tar.gz
Size 113.0 kB
Tags Source
SHA-256 checksum
How to use checksums
35e8772db307a9c37e60d703699a598e231544c2fa3d3c95b1aab656c99ede9a
BLAKE2b-256 checksum
How to use checksums
bb7608d44409055db9f7a294f0b709a6a96b7ecbd95484045ce75e743f2fed64
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.

Transparency log

Release files / cwms_cli-0.9.1-py3-none-any.whl

Download URL cwms_cli-0.9.1-py3-none-any.whl
Size 144.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fbdb29bfba6a50aa63762268d70892a8f837fdc20b7028fe995fd874c37d924a
BLAKE2b-256 checksum
How to use checksums
f9bb500e268d93969692f3a9585b6844ce67f819179e4791d1d77b2ce728b4a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 23, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.9.1 This release

2 release files

0.9.0

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.4

2 release files

0.7.3

2 release files

0.7.2

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.0

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.8

2 release files

0.3.7

2 release files

0.3.6

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.1.5

2 release files

0.1.1

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