Skip to main content

Stratis CLI

Project description

A CLI for the Stratis Project.

Introduction

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.

Installing

You can install stratis-cli directly from the stratis-cli project repo.

stratis-cli has a number of dependencies that may not already be installed. You may choose to allow the setup script to install any missing dependencies from PyPi, or you may prefer to install the dependencies using your distribution’s package manager. All stratis-cli’s direct dependencies are listed in stratis-cli’s setup.py file, in the install_requires field. If you choose to install the dependencies using your installation’s package manager, you should do so before you run the setup.py script.

Finally, run the setup.py script as:

> python setup.py install

Running

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.

Testing

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.

Internal Software Architecture

stratis is implemented in two parts:

  • The parser package handles configuring the command line parser, which uses the Python argparse package.

  • The actions package receives valid commands from the parser package and executes them, invoking the D-Bus API as needed. The parser passes command-line arguments given by the user to methods in the actions package using a Namespace object.

Python Coding Style

stratis conforms to PEP-8 style guidelines as enforced by the black formatting tool.

Tab Completion

From time to time, our external contributors have added support for tab-completion in a variety of different shells. The files are included in the stratis-cli GitHub release, but they are not supported by the Stratis project. We welcome further contributions to these files and will continue to include them for as long as they seem useful to our users.

Project details


Download files

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

Source Distribution

stratis_cli-3.7.0.tar.gz (48.7 kB view details)

Uploaded Source

Built Distribution

stratis_cli-3.7.0-py3-none-any.whl (72.4 kB view details)

Uploaded Python 3

File details

Details for the file stratis_cli-3.7.0.tar.gz.

File metadata

  • Download URL: stratis_cli-3.7.0.tar.gz
  • Upload date:
  • Size: 48.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.6

File hashes

Hashes for stratis_cli-3.7.0.tar.gz
Algorithm Hash digest
SHA256 da7c97ff645058022e3ad71f557f50fdd76e3b4a3a020bdc6452a6658c598a77
MD5 4d15ed90b7d2fca37a246844ece9952c
BLAKE2b-256 ce6cbf1547cae298ed1673745909330fa55345615abb1c27f4568ba2bb2ae09f

See more details on using hashes here.

File details

Details for the file stratis_cli-3.7.0-py3-none-any.whl.

File metadata

  • Download URL: stratis_cli-3.7.0-py3-none-any.whl
  • Upload date:
  • Size: 72.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.6

File hashes

Hashes for stratis_cli-3.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 911c62f331e20eceb643c2068ed5e1e099945bbdc41adeee13d4a635154a495c
MD5 20ca95c83a71c20cc88a9622bec5588c
BLAKE2b-256 0fc52b66cafcd3512bf791cb20aae6b5f608487e363879e65107c0c81233490d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page