Skip to content
/ pyproject-tmpl Public template

Template for Python projects

License

Notifications You must be signed in to change notification settings

mnot/pyproject-tmpl

Repository files navigation

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 and Calendar Versioning;
  • Uses GitHub Actions to build releases and publish them to PyPi automatically when a version tag is pushed;
  • Runs lint, typecheck, and test upon push using GitHub Actions;
  • Turns on Dependabot for github-actions and pip.

Use

Create a repo using the template, and then:

  1. In all files, replace:
  2. SHORTNAME with the name of the project, as published on PyPi
  3. DESCRIPTION with a textual description of the project
  4. PROJECT_URL with a URL to the project home
  5. Change the top-level SHORTNAME directory name to the name of the project;
  6. Update Makefile, pyproject.toml and requirements.txt to suit;
  7. Change this README.md to suit;
  8. Write some code.

About

Template for Python projects

Resources

License

Stars

Watchers

Forks