cookiecutter_python

About

HPE Python project repository template for Open Source Software.

See https://github.com/audreyr/cookiecutter.

• Open Source license: Apache 2.0.
• Automation setup using Tox for Python 2.7 and Python 3.4.
• Testing setup with pytest.
  • Generates execution and coverage XML reports.
  • Autodiscovery and execution of doctest.
• PEP8 compliance checking with Flake8.
  • Includes a git pre-commit hook.
  • Includes configuration using EditorConfig.
• Documentation setup with Sphinx.
  • Automatic API generation using AutoAPI.
  • Built-in support for PlantUML, Graphviz and Ditaa diagrams using Plantweb.
• Lightweight Python source distribution for PyPI.

Usage

This repository has two branches:

• module
• executable

Which branch to use depends on the kind of project you want to create. If an executable and a module is needed the use the executable branch. If just a pure Python module is required then use the module branch.

Generate a new Python project using this template:

pip3 install cookiecutter
git clone https://github.com/HPENetworking/cookiecutter_python.git
cd cookiecutter_python
git checkout <executable or module>
cookiecutter .

Improvements

• Setup Travis CI and Tox integration.
• Setup Coveralls and Tox integration.
• Integrate documentation with http://shields.io/
• Add support for changelog generation using gitchangelog