Documentation for users is available in the docs folder, and online as cli.arkindex.org.
Requirements:
mkvirtualenv cli
pip install -e .
arkindex -h
Tox is used on this project to run all unit tests:
pip install tox
tox
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.
Please keep the documentation updated when modifying or adding commands.
It's pretty easy to do:
pip install .[docs]
mkdocs serve
You can then write in Markdown in the relevant docs/*.md files, and see live output on http://localhost:8000
FAQs
Arkindex CLI client easy and sexy to use
We found that arkindex-cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.