![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=status&status=active&color=seagreen)
![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=doc&status=MkDocs&color=blue)
![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=jenkins-unittest&job={{repository}}-{{branch}})
![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=coverage)
![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=maintainability)
![](https://chacha.ddns.net/jenkins/buildStatus/icon?job={{repository}}-{{branch}}&build=0&config=quality)
![](https://chacha.ddns.net/jenkins/buildStatus/icon?subject=licence&status=CC%20BY-NC-SA%204.0&color=teal)

![](docs-static/Library.jpg)

# Python project template

A nice template to start blank python projets.
 
This template automate a lot of handy things and allow CI/CD automatic releases generation.

It is also collectings data to feed Jenkins build.

Checkout [Latest Documentation](https://chacha.ddns.net/mkdocs-web/chacha/{{repository}}/{{branch}}/latest/).

## Features

### Generic pipeline skeleton:
    - Prepare
    - GetCode
    - BuildPackage
    - Install
    - CheckCode
    - PlotMetrics
    - RunUnitTests
    - GenDOC
    - PostRelease
    
### CI/CD Environment
    - Jenkins
    - Gitea (with patch for dynamic Readme variables: https://chacha.ddns.net/gitea/chacha/GiteaMarkupVariable)
    - Docker
    - MkDocsWeb
    
### CI/CD Helper libs
    - VirtualEnv
    - Changelog generation based on commits
    - copier
    - pylint + pylint_json2html
    - mypy
    - unittest + xmlrunner + junitparser + junit2htmlreport
    - mkdocs

### Python project
    - Full .toml implementation
    - .whl automatic generation
    - dynamic versionning using git repository
    - embedded unit-test