README.md

Python3 Seed

Overview

A boilerplate Python 3 project set up for unit tests and continuous integration.

Specifically:

• Enforces Python style rules with YAPF
• Performs static analysis with pyflakes and pylint
• Sorts imports with isort

Installation

mkdir -p ./venv && \
  virtualenv --python python3 ./venv && \
  . venv/bin/activate && \
  pip install --requirement dev_requirements.txt && \
  ./dev-scripts/enable-git-hooks

Customization

To customize this for your project:

1. Change LICENSE to a license of your choosing.
2. Change the CircleCI badge in README.md to your own Circle CI project badge.
3. Change the app name in main.py from Python Seed to your app's name.
4. Rename app/dummy.py and app/dummy_test.py to the module names of your choosing.
5. Begin working.

Run

./main.py