CONTRIBUTING.md

Start by cloning the repository:

$ git clone https://github.com/Astropilot/thumbhash-python
$ cd thumbhash-python

We recommand that you create a virtual environment:

$ python -m venv env

Then activate the environment with:

# For linux
$ source ./env/bin/activate

# For Windows PowerShell
$ .\env\Scripts\Activate.ps1

Make sure you use the latest pip version by upgrading it to prevent any error on the next steps:

$ python -m pip install --upgrade pip

Then install the project in editable mode and the dependencies with:

$ pip install -e '.[dev,test]'

To run all the tests you can use the following command:

$ pytest tests