CONTRIBUTING.md

Contributing Guide

Development Setup

You will need the following tools installed:

• Python 3.7
• Poetry

Once they're installed, you can clone the repository, setup a virtual environment, and install dependencies:

git clone https://github.com/Opentrons/junk-drawer.git
cd junk-drawer
poetry install

Development Tasks

All tasks should be run in the virtualenv by using poetry run or by activating the virtualenv using poetry shell

# run tests
poetry run pytest

# run tests in watch mode
poetry run pytest --looponfail --color="yes"

# run formatting
poetry run black .

# run lints
poetry run flake8

# run type checks
poetry run mypy

# run everything
poetry run black . && poetry run flake8 && poetry run mypy && poetry run pytest

Build and Publish Tasks

# build wheel file
poetry build