diff --git a/CHANGELOG.md b/CHANGELOG.md index 2c9cc31..5e85cae 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,11 +4,22 @@ ### New features +### Improvements + +## [1.0.0](https://github.com/viperior/python-project-template/tree/v1.0.0) (2022-05-06) + +### New features + * Configure the `setuptools` build tool by creating the required metadata files ### Improvements * Move pylint usage from the pytest test suite to a GitHub Actions workflow +* Document universally important project aspects in readme (closes [#13][i13]) +* Update reference to build.yaml file in badge URL (closes [#38][i38]) + +[i13]: https://github.com/viperior/python-project-template/issues/13 +[i38]: https://github.com/viperior/python-project-template/issues/38 ## [0.7.0](https://github.com/viperior/python-project-template/tree/v0.7.0) (2022-02-26) diff --git a/README.md b/README.md index 56eab29..44c7bb4 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,39 @@ # python-project-template -This is a template for Python projects that includes automated test cases implemented using pytest. +This is a template for Python projects that provides a starting structure and a set of universally useful CI/CD configurations. -![build](https://github.com/viperior/python-project-template/actions/workflows/python-app.yml/badge.svg) +![build](https://github.com/viperior/python-project-template/actions/workflows/build.yml/badge.svg) + +## What is this for? + +This template can be used as a starting point for new Python projects to get up and running quickly with a standard set of CI/CD configurations and an organized project structure. + +| Operation | Solution Choice | +| --------------------- | -------------------------------------------------------- | +| Linting | flake8, pylint | +| Testing | pytest | +| Building | setuptools | +| Dependency management | pip-tools, dependabot | +| Additional features | changelog, example MIT license, dependabot configuration | + +## How do I build it? + +```bash +python -m build +``` + +## How do I run it? + +```bash +python -m pip install -r requirements.txt +python -m callable +``` + +## How do I test it? + +```bash +python -m pytest +``` ## Project structure @@ -11,3 +42,16 @@ project_root ├───games_of_chance └───tests ``` + +## Resources + +- Using GitHub template repositories +- GitHub Actions +- pylint +- flake8 +- pytest +- setuptools +- pip-tools +- dependabot +- Changelog generation +- MIT license