Project Title

Short description of project goes here.

---

Environment

List of dependencies for package to run.

Required

• List required installations

Optional

• List optional installations

---

Installation / Build / Deployment

Install module

> python -m pip install .

For development, install as a link to repository such that code changes are used.

> python -m pip install -e .

Execute module

> python -m project_template

---

Usage

Explain how to use your project.

Give example use cases

---

Running Tests

Explain how to run the automated tests.

> python setup.py test

---

Development

Code development of this project adheres to Google Python Guide

Styling

Use yapf to format files, based on Google's guide with the exception of indents being 2 spaces.

---

Versioning

Versioning of this projects adheres to Semantic Versioning and is implemented using git tags.