Integrate cmd2 Into Your Project
Once installed, you will want to ensure that your project's dependencies include cmd2
. Make sure your pyproject.toml
or setup.py
includes the following dependency
'cmd2>=2.4'
The cmd2
project uses Semantic Versioning, which means that any incompatible API changes will be release with a new major version number. The public API is documented in the API Reference.
We recommend that you follow the advice given by the Python Packaging User Guide related to install_requires. By setting an upper bound on the allowed version, you can ensure that your project does not inadvertently get installed with an incompatible future version of cmd2
.
OS Considerations
If you would like to use Tab Completion, then you need a compatible version of readline installed on your operating system (OS). cmd2
forces a sane install of readline
on both Windows
and MacOS
, but does not do so on Linux
. If for some reason, you have a Linux OS that has the Editline Library (libedit) installed instead of readline
, you will need to manually add a dependency on gnureadline
. Make sure to include the following dependency in your pyproject.toml
or setup.py
:
'gnureadline'