https://github.com/mnot/pyproject-tmpl
Template for Python projects
https://github.com/mnot/pyproject-tmpl
Last synced: over 1 year ago
JSON representation
Template for Python projects
- Host: GitHub
- URL: https://github.com/mnot/pyproject-tmpl
- Owner: mnot
- License: mit
- Created: 2023-09-17T08:49:07.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-13T22:24:33.000Z (over 1 year ago)
- Last Synced: 2025-02-10T13:37:29.812Z (over 1 year ago)
- Language: Python
- Homepage:
- Size: 35.2 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Python Project Template
This is a GitHub template repository for Makefile-driven Python projects. It:
* Has `lint`, `typecheck`, `clean`, and `tidy` rules, along with all of the `venv` rules;
* Can be extended to incorporate other languages by adding their tasks to `Makefile`;
* Uses tags in the form `vxx.xx.xx` to denote versions;
* Has targets that bump versions for both [Semantic Versioning](https://semver.org/) and [Calendar Versioning](https://calver.org/);
* Uses GitHub Actions to build releases and publish them to PyPi [automatically](https://docs.pypi.org/trusted-publishers/) when a version tag is pushed;
* Runs `lint`, `typecheck`, and `test` upon push using GitHub Actions;
* Turns on [Dependabot](https://docs.github.com/en/code-security/dependabot) for `github-actions` and `pip`.
## Use
Create a repo using the template, and then:
1. In **all** files, replace:
1. `SHORTNAME` with the name of the project, as published on PyPi
2. `DESCRIPTION` with a textual description of the project
3. `PROJECT_URL` with a URL to the project home
2. Change the top-level `SHORTNAME` directory name to the name of the project;
3. Update `Makefile`, `pyproject.toml` and `requirements.txt` to suit;
4. Change this `README.md` to suit;
5. Write some code.