Metadata-Version: 2.3
Name: aqora-cli
Version: 0.3.3
Requires-Dist: uv >=0.3.2, <1.0.0
Requires-Dist: build >=1.2.0, <2.0.0 ; extra == 'venv'
Requires-Dist: setuptools >=61.0 ; extra == 'venv'
Requires-Dist: ujson >=5.9.0, <6.0.0 ; extra == 'venv'
Requires-Dist: jupyterlab >=4.2.1, <5.0.0 ; extra == 'venv'
Requires-Dist: ipykernel >=6.29.4, <7.0.0 ; extra == 'venv'
Requires-Dist: nbconvert >=7.16.4, <8.0.0 ; extra == 'venv'
Requires-Dist: nbformat >=5.10.4, <6.0.0 ; extra == 'venv'
Provides-Extra: venv
Summary: The aqora command line interface
Author-email: "S.A.S Aqora Quantum" <hello@aqora.io>
Requires-Python: >=3.8
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: Repository, https://github.com/aqora-io/cli
Project-URL: Documentation, https://github.com/aqora-io/cli

# Installation

To install the CLI, you can use pip. Note that the CLI requires Python 3.9 or greater

```bash
# with pip
pip install aqora-cli

# with pipx
pipx install aqora-cli

# on Windows with Python installed from python.org
py -m pip install aqora-cli

# on Windows with Python installed from the Windows Store
python -m pip install aqora-cli
```

## Notes for Windows users

If pip gives you a warning that the script is not on your PATH, you can copy the
directory in the warning and add it to your path by [following the instructions
here](https://www.java.com/en/download/help/path.html)

You may also need to install the latest Visual C++ Redistributable Version. You
can find [the latest version here](https://learn.microsoft.com/cpp/windows/latest-supported-vc-redist?view=msvc-170#latest-microsoft-visual-c-redistributable-version)

# Getting Started

To verify the installation, the following should output helpful information

```bash
aqora help
```

Once the CLI has installed you can login to your account with the following command

```bash
aqora login
```

Browse the competitions on [aqora.io](https://aqora.io) and climb the leaderboards!

# Contributing

We strongly recommend you to install a stable Rust toolchain using [Rustup](https://rustup.rs/), and a
[stable Python](https://www.python.org/downloads/) runtime through official distributions.

Our main branch is called `main`. Please open a pull-request up-to-date to that branch
when you request our feedback.

Please follow [Conventional
Commits](https://www.conventionalcommits.org/en/v1.0.0/), which allows our
project to have beautiful changelogs based on your commit messages. We strongly
encourage you to install [Cocogitto](https://docs.cocogitto.io/):

```bash
$ cargo install cocogitto cargo-edit
$ cog install-hook --all


