supervision/README.md

👋 hello

A set of easy-to-use utils that will come in handy in any Computer Vision project. Supervision is still in pre-release stage. 🚧 Keep your eyes open for potential bugs and be aware that at this stage our API is still fluid and may change.

💻 install

# clone repository and navigate to root directory
git clone git@github.com:roboflow/supervision.git
cd supervision

# setup python environment and activate it
python3 -m venv venv
source venv/bin/activate

# install
pip install -e ".[dev]"

🧹 Code Quality

We provide two handy commands inside the Makefile, namely:

• make style to format the code
• make check_code_quality to check code quality (PEP8 basically)

So far, there is no types checking with mypy. See issue.

🧪 Tests

pytests is used to run our tests.