Contributing

Environment setup

1. Install miniconda: https://docs.conda.io/en/latest/miniconda.html

2. Clone the repository:

$ git clone https://github.com/vedb/pupil_recording_interface
$ cd pupil_recording_interface

1. Create the conda environment:

$ conda env create

1. Activate the environment:

$ conda activate pri

1. Install the package:

$ pip install --no-deps -e .

Reformatting / linting

Reformat with black:

$ black .

Lint with flake8:

$ flake8 --ignore=E203,W503,W504 pupil_recording_interface

The above steps are also run by pre-commit. Run this to automatically reformat and lint before every commit:

$ pre-commit install

Testing

Test with pytest

$ py.test

Documentation

Build docs with sphinx:

$ make -C docs/ html

Run doctests:

$ make -C docs/ doctest