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.
9 Dec 14, 2022
2 Mar 01, 2022
23 Dec 02, 2022
2 May 04, 2022
3 Nov 28, 2021
9 Sep 08, 2022
2 Feb 02, 2022
1 May 03, 2022
56 Nov 29, 2022
1 Feb 23, 2022
290 Dec 26, 2022
10 Nov 26, 2022
4 Oct 28, 2022
5 Mar 31, 2022
4.7k Jan 02, 2023
3 Jan 10, 2022
1 Nov 24, 2021
3 Sep 20, 2021
10 Dec 21, 2022
8 Sep 13, 2022