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. 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.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cwms_cli-0.9.0.tar.gz | 113.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cwms_cli-0.9.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 257.5 kB
Release files / cwms_cli-0.9.0.tar.gz
| Download URL | cwms_cli-0.9.0.tar.gz |
|---|---|
| Size | 113.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0ac2fdd7c497e093ca557810cf421089f192bef80fc1b18c464ef77525ecc45a
|
|
BLAKE2b-256 checksum How to use checksums |
947a0a4a2bef98ffbaa5f004b0166692c6eed531215b8d22af98af7a86c72450
|
| 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 21, 2026.
Transparency logRelease files / cwms_cli-0.9.0-py3-none-any.whl
| Download URL | cwms_cli-0.9.0-py3-none-any.whl |
|---|---|
| Size | 144.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
69f527d5b15d740085431dcd9159af52064e1f9d2f1fd758a6b2fad58ca02734
|
|
BLAKE2b-256 checksum How to use checksums |
3145ebe5ea788f0422b1df07087a72f591148d9d81ffc88a1fa04c7052bfc91a
|
| 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 21, 2026.
Transparency log