OxRSE Continuous Integration course

This repository contains a small Python package for summarising experimental measurements. Over the course you will use free cloud services to automate:

• unit testing on multiple Python versions
• unit testing on multiple operating systems
• static analysis
• coverage testing
• checking that public functions are documented
• documentation generation and deployment

The package

src/ci_course/
    io.py       read measurements from a CSV file
    stats.py    summarise a column of measurements
    report.py   write a summary report
    cli.py      the ci-course command
tests/

Setting up

You will need Python 3.12 or later. From the repository directory, create and activate a virtual environment using the commands for your shell.

Platform and shell	Create	Activate
Linux / macOS, bash or zsh	python3 -m venv venv	source venv/bin/activate
Windows, Command Prompt	python -m venv venv	venv\Scripts\activate.bat
Windows, PowerShell	python -m venv venv	.\venv\Scripts\Activate.ps1

Install this project:

python -m pip install -e ".[dev,docs]"

The -e matters: it installs the project in editable mode, so that the package you import is the source tree you are editing.

Running the package and checks

Try the command line tool and run the checks:

ci-course                     # summarise the bundled sample data
pytest                        # run the tests
ruff check .                  # run the linter
ruff check --select D src/    # check the docstrings

This repository is the starting point for the practical, so some checks may report problems. Follow the practical instructions to investigate the results and improve the project.