Python Project Template
A low dependency and really simple to start project template for Python Projects.
See also Flask-Project-Template for a full feature Flask project including database, API, admin interface, etc.
HOW TO USE THIS TEMPLATE
DO NOT FORK this is meant to be used from Use this template feature.
- Click on Use this template
- Give a name to your project
(e.g.my_awesome_projectrecommendation is to use all lowercase and underscores separation for repo names.) - Wait until the first run of CI finishes
(Github Actions will process the template and commit to your new repo) - If you want codecov Reports and Automatic Release to PyPI
On the new repositorysettings->secretsadd yourPIPY_API_TOKENandCODECOV_TOKEN(get the tokens on respective websites) - Read the file CONTRIBUTING.md
- Then clone your new project and happy coding!
NOTE: WAIT until first CI run on github actions before cloning your new project.
What is included on this template?
-
๐ผ๏ธ Templates for starting multiple application types:- Basic low dependency Python program (default) use this template
- Flask with database, admin interface, restapi and authentication use this template. or Run
make initafter cloning to generate a new project based on a template.
-
๐ฆ A basic setup.py file to provide installation, packaging and distribution for your project.
Template uses setuptools because it's the de-facto standard for Python packages, you can runmake switch-to-poetrylater if you want. -
๐ค A Makefile with the most useful commands to install, test, lint, format and release your project. -
๐ Documentation structure using mkdocs -
๐ฌ Auto generation of change log using gitchangelog to keep a HISTORY.md file automatically based on your commit history on every release. -
๐ A simple Containerfile to build a container image for your project.
Containerfileis a more open standard for building container images than Dockerfile, you can use buildah or docker with this file. -
๐งช Testing structure using pytest -
โ Code linting using flake8 -
๐ Code coverage reports using codecov -
๐ณ๏ธ Automatic release to PyPI using twine and github actions. -
๐ฏ Entry points to execute your program usingpython -mor$ project_namewith basic CLI argument parsing. -
๐ Continuous integration using Github Actions with jobs to lint, test and release your project on Linux, Mac and Windows environments.
Curious about architectural decisions on this template? read ABOUT_THIS_TEMPLATE.md
If you want to contribute to this template please open an issue or fork and send a PULL REQUEST.
project_name
project_description
Install it from PyPI
pip install project_name
Usage
from project_name import BaseClass
from project_name import base_function
BaseClass().base_method()
base_function()
$ python -m project_name
#or
$ project_name
Development
Read the CONTRIBUTING.md file.
2 Dec 05, 2021
22 Jan 11, 2022
419 Jan 01, 2023
391 Jan 01, 2023
134 Jan 07, 2023
18 Nov 13, 2022
3 Dec 13, 2021
22 Jan 11, 2022
61 Jan 06, 2023
1.2k Dec 30, 2022
4.7k Dec 29, 2022
9 May 25, 2022
7 Apr 19, 2022
18 Dec 31, 2022
3 May 06, 2022
1 Jan 05, 2022
3 Oct 17, 2021
9 May 27, 2022
1 Jan 18, 2022
1 Nov 05, 2021