Contributor Guide

This package is actively seeking contributors! If you are interested in contributing to this package, please read the following guide.

Install the development dependencies

Assuming you have forked EyeLinkIO, and cloned your fork to your local machine, you can install the development dependencies by running the following command from the root of the package:

$ pip install -e '.[dev]'

Running the tests

We use pytest to run unit tests, ruff to run linting, and NumpyDoc to check and build docstrings. To run the tests after you have installed the development dependencies, run the following command from the root of the package:

$ pytest

$ ruff check src/eyelinkio

To build the docs:

$ cd docs
$ make html