🏗️ Python Continuous Integration - Example

This repository shows a basic example of CI/CD in python with . It can be used as a template to set up a new project.

Navigate to the branch example-failed-unittest or example-failed-pylint to view what a failed build will look like.

Features

Static code analysis with pylint.
Type checking with mypy.
Testing with python unittest module.
Code coverage with coverage module.

Usage

Download the source code and use it as a template for your new python project.
You need to follow this configuration to use the dynamic badges. Alternative: Just remove the "Create Badge" step from the yml file to disable the feature.

Output

This template uses GitHub Actions to run all the tools. It will generate dynamic badges with the dynamic-badges action.
Alternatively you can just look at the console output: GitHub Actions Output.

An example build can look like this:

Python Lecture for DHBW - Computer Science

🧑 Julius Wiedemann