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.

If you want codecov Reports and Automatic Release to PyPI
On the new repository settings->secrets add your PIPY_API_TOKEN and CODECOV_TOKEN (get the tokens on respective websites)

📦 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 run make switch-to-poetry later 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.
Containerfile is 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 using python -m <bookish_enigma> or $ bookish_enigma with basic CLI argument parsing.
🔄 Continuous integration using Github Actions with jobs to lint, test and release your project on Linux, Mac and Windows environments.

bookish_enigma

Awesome bookish_enigma created by conradstorz

pip install bookish_enigma

from bookish_enigma import BaseClass
from bookish_enigma import base_function

BaseClass().base_method()
base_function()

$ python -m bookish_enigma
#or
$ bookish_enigma