DO NOT FORK, CLICK ON "Use this template" - A github template to start a Python Project - this uses github actions to generate your project based on the template.
A low dependency and really simple to start project template for Python Projects.
See also
DO NOT FORK this is meant to be used from Use this template feature.
my_awesome_project
recommendation is to use all lowercase and underscores separation for repo names.)settings->secrets
add your PYPI_API_TOKEN
and CODECOV_TOKEN
(get the tokens on respective websites)NOTE: WAIT until first CI run on github actions before cloning your new project.
make init
after cloning to generate a new project based on a template.
make switch-to-poetry
later if you want.Containerfile
is a more open standard for building container images than Dockerfile, you can use buildah or docker with this file.python -m <project_name>
or $ project_name
with basic CLI argument parsing.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_description
pip install project_name
from project_name import BaseClass
from project_name import base_function
BaseClass().base_method()
base_function()
$ python -m project_name
#or
$ project_name
Read the CONTRIBUTING.md file.