Utilities for testing Python code and its downstream dependencies, submitting coverage reports, conducting static analyses, and generating documenation
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.circleci
docs
karr_lab_build_utils
tests
.gitignore
.karr_lab_build_utils.yml
LICENSE
MANIFEST.in
README.md
requirements.optional.txt
requirements.txt
setup.cfg
setup.py

README.md

[//]: # ( PyPI package ) Documentation Test results Test coverage Code analysis License Analytics

Karr Lab build utilities

This package performs several aspects of the Karr Lab's build system:

  • Create repositories with our default directory structure and files

    • Files for packaging Python code
    • Sphinx documentation configuration
    • CircleCI build configuration
  • Tests code with Python 2 and 3 using pytest locally, using a Docker image, or using the CircleCI local executor

  • Uploads test reports to our test history server

  • Uploads coverage report to Coveralls

  • Generates HTML API documentation using Sphinx

The build system is primarily designed for:

  • Code that is implemented with Python 2/3
  • Tests that can be run with pytest
  • Code that is documented with Sphinx in Napolean/Google style
  • Continuous integration with CircleCI

Installation

Please see the documentation.

Documentation

Please see the documentation.

License

The build utilities are released under the MIT license.

Development team

This package was developed by Jonathan Karr at the Icahn School of Medicine at Mount Sinai in New York, USA.

Questions and comments

Please contact the Jonathan Karr with any questions or comments.