test_cookiecutter_2

Repo quality

We employ a rough 'stoplight' system for signifying the quality of code in a any given repo. Whenever you make a new repo, add any of the following badges to the top of your README.md file. Below is (rough) definitions of stoplight system currently in use. Use your own best judgement for your code :-)

Here be dragons. This could be code straight from an experiment with no guarantees for its portability. Expect a collection of scripts and just barely docstrings

Decently factored code with well-documented and somewhat portable programming.

High-level fully featured code with many moving parts and used broadly.

These banners generated from shields.io.

Description

Examples

Installation

Usage

Running the tests

If you have gotten 'test_cookiecutter_2' from source, you may run the tests locally.

Install test_cookiecutter_2 along with its test dependencies into your virtual environment by executing the following in the root folder

$ pip install .[test]

Then run pytest in the tests folder.

Building the documentation

If you have gotten test_cookiecutter_2 from source, you may build the docs locally.

Install test_cookiecutter_2 along with its documentation dependencies into your virtual environment by executing the following in the root folder

$ pip install .[docs]

You also need to install pandoc. If you are using conda, that can be achieved by

$ conda install pandoc

else, see here for pandoc's installation instructions.

Then run make html in the docs folder. The next time you build the documentation, remember to run make clean before you run make html.