Development

This page contains reference material for those interested in developing and contributing to the hostedpi module.

The project source code is hosted on GitHub at https://github.com/piwheels/hostedpi which also includes the issue tracker and CI.

Setting up for Development

1. Clone the repository and enter the directory:

   $ git clone https://github.com/piwheels/hostedpi
   $ cd hostedpi
   

2. Create a virtual environment e.g. using virtualenvwrapper:

   $ mkvirtualenv hostedpi
   

3. Install the project for development:

   $ make develop
   

Run the tests

Run the tests in your environment with:

$ make test

Or you can run the tests directly with pytest for more control:

$ pytest -vv

Format code

Format code with isort and black:

$ make format

GitHub Actions

GitHub Actions are used to run tests and formatter checks on every commit and pull request: https://github.com/piwheels/hostedpi/actions