Metadata-Version: 2.1
Name: cornerstone
Version: 0.5.1
Summary: Basic github repository setup for python projects.
Home-page: https://github.com/KraYmer/cornerstone
Author: Fabrice Laporte
Author-email: kraymer@gmail.com
License: MIT
Platform: ALL
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pytest
Provides-Extra: test
Requires-Dist: coverage (>5) ; extra == 'test'
Requires-Dist: pytest (>=6) ; extra == 'test'
Requires-Dist: tox (>=3) ; extra == 'test'

<p align="center">
   <img align="center" src="https://github.com/Kraymer/__pub/raw/master/logo_cornerstone.png" width="200" >

[![](https://readthedocs.org/projects/cornerstone/badge/?version=latest)](http://cornerstone.readthedocs.org/en/latest/?badge=latest)
[![](https://pepy.tech/badge/cornerstone)](https://pepy.tech/project/cornerstone)

</p>


# 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

~~~
git clone git@github.com:Kraymer/cornerstone.git YOUR_PROJECT
sed -i 's/cornerstone/YOUR_PROJECT/g' **/*setup*
~~~

Please read [documentation](https://cornerstone.readthedocs.io/en/latest/) for further instructions.

