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:
npm install
npm antora antora-playbook.yml
You can then write in Asciidoc in the relevant docs/*.adoc files, and see output on the specified html file.
1 maintainer
Metadata
1 maintainer
Release files for arkindex-cli 0.5.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| arkindex_cli-0.5.0.tar.gz | 309.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| arkindex_cli-0.5.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 643.1 kB
Release files / arkindex_cli-0.5.0.tar.gz
| Download URL | arkindex_cli-0.5.0.tar.gz |
|---|---|
| Size | 309.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
13c76687ba52eaad4a01887017ba9e7b5c78e30ed19cdc840234ef2ac08d6a66
|
|
BLAKE2b-256 checksum How to use checksums |
d244da55532a9504507aaa32616bb5cb303b623b747044b76604ceeabe142f4f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.20
|
Release files / arkindex_cli-0.5.0-py3-none-any.whl
| Download URL | arkindex_cli-0.5.0-py3-none-any.whl |
|---|---|
| Size | 333.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e8d16b94618c5a42e3e65dde9f8461e2bc04577fc7063bc096b81694d1021781
|
|
BLAKE2b-256 checksum How to use checksums |
c85fe3c4efa69938520f1ea34c545fcffb476d785016eef38c4466133b6f66d3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.20
|
