Installation

User Install

pip install git+https://github.com/alan-turing-institute/rctab-cli

Developer Install

To get started install Poetry.

Then from the root of the repository, install dependencies and activate a Poetry shell, which we will assume is active for the rest of the document, with

poetry install
eval $(poetry env activate)

You should also install pre-commit and install the pre-commit hooks with

pre-commit install --install-hooks

run the non-safety pre-commit hooks with

pre-commit run --all-files

set an environment variable with your safety API key

export SAFETY_API_KEY=your-api-key

and run the safety hook with

pre-commit run --all-files --config .pre-commit-safety.yaml