Skip to content

drsmith48/project_template

Repository files navigation

ProjectTemplate

Travis-CI AppVeyor Documentation Status Test Coverage Code Quality Code Issues Updates Python 3 Latest Release

A Python project template with several best-practice features/integrations

  • Continuous integration
    • Linux and OSX coverage at Travis-CI
    • Windows coverage at AppVeyor
    • Coverage for several Python and Numpy versions
  • Documentation with Sphinx
  • Testing with pytest and tox
    • Run pytest or make test to test in current environment
    • Run tox or make test-all to test in multiple virtual envs
      • Test matrix covers several Python and Numpy versions
  • Quaity checks with coverage and flake8
    • Run coverage or make coverage for test coverage report
    • Run flake8 or make lint for code style/quality checks
    • Analysis at Code Climate and QuantifiedCode
  • Dependency updates and Python 3 compatability at PyUp.io
  • Version management with bumpversion
    • Run bumpversion major|minor|patch to increment version project-wide
  • Makefile recipes
    • Run make for recipe summaries

This project is adapted from the Cookiecutter package utility and the PyPackage template.