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.

- 📖 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. 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.

Download files

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

Source Distribution

cwms_cli-0.8.0.tar.gz (109.2 kB view details)

Uploaded Aug 10, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

cwms_cli-0.8.0-py3-none-any.whl (139.6 kB view details)

Uploaded Aug 10, 2026 Python 3

File details

Details for the file cwms_cli-0.8.0.tar.gz.

File metadata

Download URL: cwms_cli-0.8.0.tar.gz
Upload date: Aug 10, 2026
Size: 109.2 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for cwms_cli-0.8.0.tar.gz
Algorithm	Hash digest
SHA256	`af033c014475f469174a88ac2111a58cda935e0216c9aa2000959369a94375d4`
MD5	`197e1611e12e560d99f634a45aa30d09`
BLAKE2b-256	`28a1e1d0514d51066ab9ca42e53ecfbae5dce0271e42708ffd300a40205d8a17`

See more details on using hashes here.

Provenance

The following attestation bundles were made for cwms_cli-0.8.0.tar.gz:

Publisher: release-please.yml on HydrologicEngineeringCenter/cwms-cli

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

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: cwms_cli-0.8.0.tar.gz
- Subject digest: af033c014475f469174a88ac2111a58cda935e0216c9aa2000959369a94375d4
- Sigstore transparency entry: 2410242779
- Sigstore integration time: Aug 10, 2026
Source repository:
- Permalink: HydrologicEngineeringCenter/cwms-cli@31e503e0307049e36c646ec75b211a6d9ba50d8d
- Branch / Tag: refs/heads/main
- Owner: https://github.com/HydrologicEngineeringCenter
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release-please.yml@31e503e0307049e36c646ec75b211a6d9ba50d8d
- Trigger Event: push