Project Title

One Paragraph of project description goes here

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Give examples

Installing

A step by step series of examples that tell you have to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

To run the tests associated with this project, run make test.

For code coverage, run make coverage.

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

• numpy - The scientific computing library used
• pandas - Used for data munging
• pip-tools - Dependency Management
• pytest - Used to test the application

Contributing

To contribute to this project, go ahead and clone it and issue a pull request.

###Coding Guidelines

Please conform to PEP-8 standards for all developm ent.

The pep8 and autopep8 modules are a part of the dev-requirements, and has been added to the Makefile. Please edit for your project, and change sample to the module for your project. Once this is completed, you can run make pep8 for statistics, or make pep8-verbose for a detailed breakout of violations.

If you wish to automatically manage adherance to the PEP8 standard, use the module autopep8. You can learn more about it here. An autopep8 action has been included in the Makefile for a sane default use as needed.

While these skeletons are meant to be a sane default, projects will occasionally deviate due to special requirements or circumstances. As such, while the skeletons take care to conform to s tandards, please use caution when deviating from these implementations.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Bobby Larson - Initial Project Skeleton - karma0

See also the list of contributors who participated in this project.

License

This project is protected software - see the LICENSE.txt file for details.

Acknowledgments

• Hat tip to anyone who's code was used
• Inspiration
• etc