Metadata-Version: 2.1
Name: armonik_cli
Version: 0.1.1
Summary: Command-line tool to monitor and manage ArmoniK clusters.
License: Apache v2.0 LICENSE
Project-URL: Homepage, https://github.com/aneoconsulting/ArmoniK.Api
Project-URL: Bug Tracker, https://github.com/aneoconsulting/ArmoniK/issues
Keywords: cloud,HTC,CLI,ArmoniK,Aneo
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Operating System :: OS Independent
Classifier: Topic :: Internet
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: armonik
Requires-Dist: click
Requires-Dist: PyYAML
Requires-Dist: rich_click
Provides-Extra: tests
Requires-Dist: coverage; extra == "tests"
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: pytest-mock; extra == "tests"
Requires-Dist: pytest-benchmark[histogram]; extra == "tests"
Provides-Extra: dev
Requires-Dist: mypy; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: types-PyYAML; extra == "dev"

# ArmoniK Admin CLI.

This repository is part of the [ArmoniK](https://github.com/aneoconsulting/ArmoniK) project. It provides a command-line tool to monitor and manage ArmoniK clusters.

## Installation

### Requirements

The CLI requires Python version 3.8 or newer. In order to install the ArmoniK CLI in an isolated environment, you must have python3-venv installed on your machine.

```bash
sudo apt update && sudo apt install python3-venv
```

### Install from source

To install the CLI from source, first clone this repository.

```bash
git clone git@github.com/aneoconsulting/ArmoniK.Admin.CLI.git
```

Navigate in the root directory

```bash
cd ArmoniK.Admin.CLI
```

Create and activate the virtual environment

```bash
python -m venv ./venv
source ./venv/bin/activate
```

Install the CLI in the environment you just created.

```bash
pip install .
```

## Contributing

Contributions are always welcome!

See [CONTRIBUTING](CONTRIBUTING.md) for ways to get started.
