Starter template for a Python app - including CI and docs 🐍 🌠
MIT License
Starter template for a Python app - including CI and docs
This project provides a template for a Python application, enabling you to get up and running fast with local development and then move quickly when you want deploy your app to the cloud with confidence.
It includes a solid setup, from installing packages to running code quality checks locally and with GitHub Actions.
What you get:
make
commands (for macOS and Linux).pip
using make
commands.flake8
, pylint
, mypy
(type checking), and pytest
, including make
commands and configs for each.Create your own repo from this one:
See the Template Notes part of the docs for more info on how to use this template. And for links to my other templates.
TODO: Add just a few lines to show how to use your application. Such as a Python or shell snippet.
$ foo-bar --help
$ make install
$ make run
import foo
foo.bar(123)
How to install and run this project
Released under MIT by @MichaelCurrin.
A copy of the original license must be included if a significant portion of this template or project is used. You could rename it to LICENSE-source
and then include your own LICENSE
file with your name.