Revolution

Revolution is the software for the next generation electrical system for Blue Sky Solar Racing.

Project Setup

In project root directory, create a Python virtual environment.

python -m venv venv

Activate the Python virtual environment.

source venv/bin/activate

Install the project requirements.

pip install -r requirements.txt

Code Style and Static Type Checking

Run style checker.

flake8 revolution

Run static type checker.

mypy --strict revolution

Unit and Documentation Testing

Run unit tests.

export REVOLUTION_CONFIGURATIONS_MODULE=configurations.development
python -m unittest

Above is equivalent to below...

REVOLUTION_CONFIGURATIONS_MODULE=configurations.development python -m unittest

Run documentation tests.

export REVOLUTION_CONFIGURATIONS_MODULE=configurations.development
python -m doctest revolution/*.py

Above is equivalent to below...

REVOLUTION_CONFIGURATIONS_MODULE=configurations.development python -m doctest revolution/*.py

Project Deployment

Make sure all version occurrences have been updated.

Tag the release version.

git tag v<version>

Build the docker image.

docker build -t blueskysolarracing/revolution:<version> .

Push the docker image.

docker push blueskysolarracing/revolution:<version>

In deployment platform, pull the docker image and run as a docker container in detached mode.

docker run -d -v /dev:/dev -v /sys/class/pwm:/sys/class/pwm blueskysolarracing/revolution:<version>