Hoppa till innehållet

Developer guidelines/CI for python

Från Wikimedia
The below assumes a repo using Python 3 only and some of the instructions are aimed for repos on GitHub. This document also exists at phab:T159116

Files

Template repo is found on Github: https://github.com/Wikimedia-Sverige/.github-python. This contains testing that can be run locally and Github actions that will run automatically.

tox.ini
Main entrypoint specifying tests and linting to run.
requirements.txt
The dependencies needed to run the program. Install these using pip install -r requirements.txt (possibly with the --process-dependency-links flag).
requirements-test.txt
The additional dependencies needed to run the tests. The first line (-r requirements.txt) ensures that the normal dependencies are also installed.
.github/workflows/python.yml
Enables Github actions that run when something is pushed to the repo.