DEVELOPING.md

Guide to contribute to this repository

Prerequisite

1. python3
2. pip3
3. virtualenv

   pip3 install virtualenv

Steps to setup dev environment

1. Create a python3 virtual environment

   virtualenv .venv -p python3

2. Activate the virtual environment created in step 1

   source .venv/bin/activate

3. Install setuptools to package code and black to format python code

   pip3 install setuptools black

4. Install libraries in file requirements.txt

   pip3 install -r requirements.txt

Steps to install the CLI to virtual environment and run it

1. Run command to install CLI in editable mode

   pip3 install -e .

2. Verify the CLI

   which aito

3. Run aito command

   aito

Steps to package and distribute CLI to PyPI

1. Install build to generate distribution packages and twine to distribute package to PyPI

   pip3 install build twine

2. Run build command as the root folder, where file pyproject.toml is located

   rm -rf dist
   python3 -m build

   After that command, we will have tar.gz and .whl files in dist folder

3. Register an account in PyPI and create an API token with Entire account scope

4. Using twine to upload the distribution packages created in step 2 to TestPyPI

   twine upload --skip-existing dist/*

   --skip-existing if we want to distribute further versions of the cli.

   You will be prompted for a username and password. For the username, use __token__. For the password, use the token value, including the pypi- prefix.

5. Using another virtual environment and install the aitomatic using pip to verify that it works

   deactivate
   virtualenv .venv-test -p python3
   source .venv-test/bin/activate
   pip3 install aitomatic