Metadata-Version: 2.4
Name: arkindex-cli
Version: 0.4.8
Summary: Arkindex CLI client easy and sexy to use
Author-email: Teklia <contact@teklia.com>
Maintainer-email: Teklia <contact@teklia.com>
Project-URL: Homepage, https://cli.arkindex.org/
Project-URL: Documentation, https://cli.arkindex.org/
Project-URL: Repository, https://gitlab.teklia.com/arkindex/cli/
Project-URL: Bug Tracker, https://gitlab.teklia.com/arkindex/cli/issues/
Project-URL: Authors, https://teklia.com
Keywords: python
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: arkindex-export==0.2.0
Requires-Dist: minio==7.2.7
Requires-Dist: python-dateutil==2.9.0.post0
Requires-Dist: python-docx==1.1.2
Requires-Dist: python-gnupg==0.5.4
Requires-Dist: rich==13.7.1
Requires-Dist: teklia-toolbox==0.1.11
Requires-Dist: zstandard==0.23.0
Requires-Dist: python-magic==0.4.27
Provides-Extra: export
Requires-Dist: reportlab==4.2.5; extra == "export"
Provides-Extra: tests
Requires-Dist: pytest==7.4.2; extra == "tests"
Requires-Dist: pytest-mock==3.14.0; extra == "tests"
Requires-Dist: pytest-responses==0.5.1; extra == "tests"

# Arkindex CLI

Documentation for users is available in the [docs](./docs) folder, and online as [cli.arkindex.org](https://cli.arkindex.org).

## Dev setup

Requirements:
- Python 3.7+

```console
mkvirtualenv cli
pip install -e .
arkindex -h
```

### Unit tests

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

```console
pip install tox
tox
```

### Linting

We use [pre-commit](https://pre-commit.com/) 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.
