No description or website provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
.gitignore
README.md
metrics.json

README.md

// TODO docs

Verification

Automated tests

To run the tests included in this project, use following steps:

  1. $ cd ${PROJECT_DIR}/src
  2. $ python -m unittest discover

-m unittest discover run the unittest module and discover any python files that start with string "test". Such test scripts should have a top level function, ideally called suite()

Optional step may be carried out to ensure code complies with Python 3: 3. $ python3 -m unittest discover

Note that Python versions on commands python and python3 may vary depending on current machine set up.

Desired output on both step 2. and 3. is something like:


----------------------------------------------------------------------
Ran 3 tests in 0.002s

OK

Note that number of tests ran and time to run may vary as this project develops.

Warning: Please always make sure there are more than 0 tests ran as that is an indication of a problem.