{"id":13648153,"url":"https://github.com/stratis-storage/stratis-cli","last_synced_at":"2025-04-22T07:30:45.018Z","repository":{"id":10780715,"uuid":"66956943","full_name":"stratis-storage/stratis-cli","owner":"stratis-storage","description":"CLI for the Stratis project","archived":false,"fork":false,"pushed_at":"2025-04-16T13:36:16.000Z","size":1870,"stargazers_count":107,"open_issues_count":26,"forks_count":21,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-04-16T20:17:35.019Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://stratis-storage.github.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stratis-storage.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.txt","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-08-30T16:09:39.000Z","updated_at":"2025-04-16T13:36:20.000Z","dependencies_parsed_at":"2023-10-21T02:29:57.447Z","dependency_job_id":"9b019af1-e83a-4b67-8c20-5e991ef58c5f","html_url":"https://github.com/stratis-storage/stratis-cli","commit_stats":null,"previous_names":[],"tags_count":44,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stratis-storage%2Fstratis-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stratis-storage%2Fstratis-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stratis-storage%2Fstratis-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stratis-storage%2Fstratis-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stratis-storage","download_url":"https://codeload.github.com/stratis-storage/stratis-cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250195033,"owners_count":21390230,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-02T01:04:00.764Z","updated_at":"2025-04-22T07:30:45.012Z","avatar_url":"https://github.com/stratis-storage.png","language":"Python","funding_links":[],"categories":["Python","others"],"sub_categories":[],"readme":"CLI for Stratis Project\n=================================\n\nA CLI for the Stratis Project.\n\nIntroduction\n------------\n`stratis-cli` is a tool that provides a command-line interface (CLI)\nfor interacting with the Stratis daemon,\n`stratisd \u003chttps://github.com/stratis-storage/stratisd\u003e`_. ``stratis-cli``\ninteracts with ``stratisd`` via\n`D-Bus \u003chttps://www.freedesktop.org/wiki/Software/dbus/\u003e`_. It is\nwritten in Python 3.\n\n``stratis-cli`` is stateless and contains a minimum of storage-related\nlogic. Its code mainly consists of parsing arguments from the command\nline, calling methods that are part of the Stratis D-Bus API, and then\nprocessing and displaying the results.\n\nInstalling\n----------\nYou can install ``stratis-cli`` directly from the ``stratis-cli`` project\nrepo.\n\n``stratis-cli`` has a number of dependencies that may not already be\ninstalled. You may choose to allow the setup script to install any missing\ndependencies from PyPi, or you may prefer to install the dependencies using\nyour distribution's package manager. All ``stratis-cli``'s direct\ndependencies are listed in ``stratis-cli``'s setup.py file, in the\n``install_requires`` field. If you choose to install the dependencies\nusing your installation's package manager, you should do so before you\nrun the setup.py script.\n\nFinally, run the setup.py script as::\n\n   \u003e python setup.py install\n\nRunning\n-------\nAfter installing, running requires invoking the script, as::\n\n   \u003e stratis --help\n\nor::\n\n   \u003e stratis --version\n\nTo run without installing, check out the source, change to the top\ndirectory and set the ``PYTHONPATH`` environment variable to include\nlibrary dependencies. For example (if using bash shell)::\n\n   \u003e export PYTHONPATH=\"src:../dbus-client-gen/src:../dbus-python-client-gen/src:../into-dbus-python/src:../dbus-signature-pyparsing/src\"\n   \u003e ./bin/stratis --help\n\nSince ``stratis`` uses stratisd's API, most operations will fail\nunless you are also running the `Stratis daemon \u003chttps://github.com/stratis-storage/stratisd\u003e`_.\n\nTesting\n-------\nVarious testing modalities are used to verify various properties of\n``stratis``.  Please consult the README files in the ``tests`` subdirectory\nfor further information.\n\nThe project has, and will continue to maintain, 100% code coverage.\n\nInternal Software Architecture\n------------------------------\n``stratis`` is implemented in two parts:\n\n* The *parser* package handles configuring the command line parser, which uses\n  the Python `argparse \u003chttps://docs.python.org/3/library/argparse.html\u003e`_ package.\n\n* The *actions* package receives valid commands from the parser package\n  and executes them, invoking the D-Bus API as needed.  The parser\n  passes command-line arguments given by the user to methods in the\n  actions package using a ``Namespace`` object.\n\nPython Coding Style\n-------------------\n``stratis`` conforms to PEP-8 style guidelines as enforced by the ``black``\nformatting tool.\n\nTab Completion\n--------------\nFrom time to time, our external contributors have added support for\ntab-completion in a variety of different shells. The files are included in the\nstratis-cli GitHub release, but they are not supported by the Stratis project.\nWe welcome further contributions to these files and will continue to include\nthem for as long as they seem useful to our users.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstratis-storage%2Fstratis-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstratis-storage%2Fstratis-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstratis-storage%2Fstratis-cli/lists"}