Skip to main content

Arkindex CLI client easy and sexy to use

Project description

Arkindex CLI

Documentation for users is available in the docs folder, and online as cli.arkindex.org.

Dev setup

Requirements:

  • Python 3.7+
mkvirtualenv cli
pip install -e .
arkindex -h

Unit tests

Tox is used on this project to run all unit tests:

pip install tox
tox

Linting

We use pre-commit to check the Python source code syntax of this project.

To avoid superfluous commits, always run pre-commit before committing.

To do that, run once :

pip install pre-commit
pre-commit install

The linting workflow will now run on modified files before committing, and may fix issues for you.

If you want to run the full workflow on all the files: pre-commit run -a.

Documentation

Please keep the documentation updated when modifying or adding commands.

It's pretty easy to do:

pip install mkdocs
mkdocs serve

You can then write in Markdown in the relevant docs/*.md files, and see live output on http://localhost:8000

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

arkindex-cli-0.2.3.tar.gz (44.2 kB view hashes)

Uploaded source

Built Distribution

arkindex_cli-0.2.3-py3-none-any.whl (60.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page