Metadata-Version: 1.1
Name: stratis-cli
Version: 2.2.0
Summary: Stratis CLI
Home-page: UNKNOWN
Author: Anne Mulhern
Author-email: amulhern@redhat.com
License: Apache 2.0
Description: CLI for Stratis Project
        =================================
        
        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 <https://github.com/stratis-storage/stratisd>`_. ``stratis-cli``
        interacts with ``stratisd`` via
        `D-Bus <https://www.freedesktop.org/wiki/Software/dbus/>`_. 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
        ----------
        
        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.
        
        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 <https://github.com/stratis-storage/stratisd>`_.
        
        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 <https://docs.python.org/3/library/argparse.html>`_ 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.
        
Platform: Linux
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: System :: Filesystems
Classifier: Topic :: Systems Administration
