Installation and Setup
This page covers installing cwms-cli, adding optional dependencies required
by certain subcommands, and configuring the shared CDA connection inputs used
across CWMS-backed commands.
Install cwms-cli
Install the base CLI package:
pip install cwms-cli
After installation, see Shell Completion if you want tab completion for supported shells.
Some commands require additional libraries that are not installed with the base package. You will be alerted to missing dependencies if you try to run a command that requires an optional library that is not installed. See the next section for more on this.
Install cwms-python for CWMS-Backed Commands
Commands that talk to CWMS, including csv2cwms, require
cwms-python:
pip install cwms-python
If you plan to use USGS-related commands, additional packages may also be required depending on the subcommand.
How Missing Dependencies Are Reported
cwms-cli subcommands use dependency checks to detect whether optional
libraries are installed. If a required library is missing, the command will
stop and print a message naming the missing module and an install command.
For example, a command may tell you to run something like:
pip install cwms-python
This means you do not have to guess which extra library is needed for a given subcommand. The command will tell you.