A CLI for the Stratis Project.
stratis-cli is a tool that provides a command-line interface (CLI)
for interacting with the Stratis daemon,
stratisd. stratis-cli
interacts with stratisd
via
D-Bus. It is
written in Python 3.
stratis-cli
is stateless and contains a minimum of storage-related
logic. Its code mainly consists of parsing arguments from the command
line, calling methods that are part of the Stratis D-Bus API, and then
processing and displaying the results.
To install, check out the source, and use the included setup script, as:
> python setup.py install
You will also need to obtain the following related Stratis repos: dbus-client-gen, dbus-python-client-gen, into-dbus-python, dbus-signature-pyparsing.
Finally, ensure you have the pyparsing package installed.
After installing, running requires invoking the script, as:
> stratis --help
or:
> stratis --version
To run without installing, check out the source, change to the top
directory and set the PYTHONPATH
environment variable to include
library dependencies. For example (if using bash shell):
> export PYTHONPATH="src:../dbus-client-gen/src:../dbus-python-client-gen/src:../into-dbus-python/src:../dbus-signature-pyparsing/src" > ./bin/stratis --help
Since stratis
uses stratisd's API, most operations will fail
unless you are also running the Stratis daemon.
Various testing modalities are used to verify various properties of
stratis
. Please consult the README files in the tests
subdirectory
for further information.
The project has, and will continue to maintain, 100% code coverage.
stratis
is implemented in two parts:
Namespace
object.stratis
conforms to PEP-8 style guidelines as enforced by the black
formatting tool.