This repository contains everything you need to make a new Python project that:
- checks against the Black code style
- performs whatever tests you like
- Does testing and format checking in parallel
- has everything needed to make a Python package that can be easily installed with
pip - automatically packages itself to PyPI on new tags (or "releases" for those who are still separating
gitfrom GitHub)
After clicking the shiny green "Use this template" button, a few things need to change to get everything going good.
- In
setup.py- The location of
__init__.py - The package name
- Your name and email
- The project short description, url
- Optionally (but a very good idea) expand the list of classifiers. You can find all the ones PyPI supports online.
- The location of
- In
.travis.yml- Set your PyPI username and password.
.travis.ymlhas instructions on protecting your password from prying eyes. - Add or remove
scriptlines. Everyscriptis called in parallel.
- Set your PyPI username and password.
LICENSE- duh- This file - replace it entirely with your own README!
You'll also need to make sure Travis has access to this repository on the create page:
And then you're done! Enjoy your slave labor automatic tests and deployments!