olivert1 / ci

OxRSE Continuous Integration course

This project contains a small Python project. We are going to use free cloud services to automate:

• unit testing on multiple Python versions
• unit testing on multiple operating systems
• coverage testing
• static analysis
• documentation generation

To make sure all dependencies are installed, we recommend creating a new virtual environment. From the directory containing this file:

python3 -m pip install --user virtualenv
python3 -m venv venv

Activate the virtual environment:

Linux / macOS:

source venv/bin/activate

Windows cmd.exe:

venv\Scripts\activate.bat

Windows PowerShell:

venv\Scripts\Activate.ps1

Windows using Git Bash:

source venv\Scripts\activate

Upgrade the build tools and install this project:

pip install --upgrade pip setuptools wheel
pip install -e .[dev,docs]