Skip to content

Starter template for a Python app - including CI and docs 🐍 🌠

License

Notifications You must be signed in to change notification settings

MichaelCurrin/py-project-template

Repository files navigation

Python Project Template 🐍 πŸ“¦

Starter template for a Python app - including CI and docs

Python CI GitHub tag License

Made with Python

code style - black dev dependency - flake8 dev dependency - pylint dev dependency - mypy dev dependency - pytest

How to use this starter project

Use this template

See the Template Notes part of the docs for more info on how to use this template. And for links to my other templates.

Sample usage

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)

Documentation

How to install and run this project

view - Documentation

License

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.