Python Project Template
A low dependency and really simple to start project template for Python Projects.
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$ g2wwith 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.
g2w
Awesome g2w created by dgroup
Install it from PyPI
pip install g2w
Usage
from g2w import BaseClass
from g2w import base_function
BaseClass().base_method()
base_function()
$ python -m g2w
#or
$ g2w
Development
Read the CONTRIBUTING.md file.
1 Dec 13, 2021
2 Jan 24, 2022
1 Dec 17, 2021
651 Dec 12, 2022
3 Nov 17, 2022
44 Oct 9, 2022
3 Oct 3, 2022
61 Jan 2, 2023
649 Dec 30, 2022
37 Dec 20, 2022
4 Apr 25, 2022
1 Nov 26, 2021
1 Apr 4, 2022
11 Oct 22, 2022
3 Jul 19, 2022
2 Nov 30, 2021
1 Dec 14, 2022
1.6k Jan 4, 2023