Kraymer / cornerstone

Solid repository foundation for your python projects.

cornerstone

/kɔrˈneːrston/

n. an indispensable and fundamental basis

cornerstone is a state-of-the-art repository setup to start a python project hosted on Github.

Features

• Markdown README.md file used for both pypi and github project homepages
• Markdown documentation hosted by readthedocs
• CI/CD automation using Github action :
  • codecov.yml upload coverage to Codecov
  • python-build lint and run unit tests
  • python-semantic-release.yml automatic changelog generation and versioning via Python Semantic Release and one click deployment to Pypi

Getting started

Create a new repository using
Use this template

button then fork it and perform following edits locally :

mv cornerstone YOUR_PROJECT
sed -i 's/cornerstone/YOUR_PROJECT/g' **/*setup*
sed -i 's/cornerstone/YOUR_PROJECT/g' .github/workflows/*
truncate -s 0 CHANGELOG.md README.md

Please read documentation for further instructions.