An easy to use template of Python script, include basic CI/CD settings.

Development

Prerequisite

Environment setup

• Install dependencies

Formatting

Code formatter

This template uses the following automatic format tool:

• black
• isort

Linting

This template uses the following linting tool:

• flake8
• pylint
• mypy

Analysis

This template uses the following security analysis tool:

• bandit
• ochrona

Test

This template uses the following testing tool:

• pytest
• pytest-cov(pytest plugin: produces coverage report)
• hypothesis(property-based testing tool)

Deploy

Prerequisite

Build image

Run container

Github workflows

CI

ci.yml

Trigger on: push and pull-request

Jobs:

1. Lint
   • Run linting tools: flake8, pylint, mypy
2. Analysis
   • Run security analysis tools: bandit, ochrona
3. tests
   • Run pytest
   • Upload testing coverage report to Codecov

Build

build.yml

Trigger on: push and Bump version complete

Jobs:

1. build-and-push-image
   • Build a test image and check the container can start without errors
   • Build and push image with test tag
   • If branch develop: build and push image with dev tag
   • If branch main: build and push image with latest and latest git tag

Bump and release version

bumpversion.yml

Trigger on: push to main branch

Tools: python commitizen tool

Jobs:

1. bump-version
   • Create bump and changelog
   • Release latest version