A repository template with working Travis CI, ReadTheDocs, and Jupyter Notebook
This is the descripion of the software.
Requirements:
- list
- of
- requirements
Install via PYPI with
pip install joe_template
or via Github with
git clone https://github.com/hover2pi/<repo_name>.git
python <repo_name>/setup.py install
Full documentation for the latest build can be found on ReadTheDocs.
The package also contains detailed Jupyter notebooks highlighting the core functionality of its primary classes, including
Here is a demo of the software with some code snippets:
from joe_template import MyClass
mc = MyClass('Great package!')
print(mc.words)
And at least one nice plot:
This project is Copyright (c) Joe Filippazzo and licensed under the terms of the BSD 3-Clause license. See LICENSE for more information.