https://github.com/butla/cookiecutter-pyapp-butla

Cookiecutter template for my Python applications
https://github.com/butla/cookiecutter-pyapp-butla

Last synced: 14 days ago
JSON representation

Cookiecutter template for my Python applications

• Host: GitHub
• URL: https://github.com/butla/cookiecutter-pyapp-butla
• Owner: butla
• License: mit
• Created: 2017-05-07T19:09:32.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-09-06T17:39:15.000Z (over 7 years ago)
• Last Synced: 2024-12-23T02:44:17.554Z (17 days ago)
• Size: 5.86 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Butla's Python app Cookiecutter

===============================

Cookiecutter_ template for a Python sample application with full test coverage

and Pylint quality control.

Features

--------

* Testing setup with `pytest`_ and `Tox`_.

* Tests separated into unit, integrated and functional categories.

* Expecting full test coverage.

* Tox setup expecting to `measure coverage in out-of-process functional tests`.

* Enforcing code quality with `Pylint`_.

Quickstart

----------

Install the latest Cookiecutter if you haven't installed it yet::

    pip3 install --user cookiecutter

Generate the project from template::

    cookiecutter gh:butla/cookiecutter-pyapp-butla

Then:

* run ``tox``

* update ``requirements-test.txt`` with frozen dependencies of coverage, pylint, and pytest.

Credits

-------

This template was based on `audreyr/cookiecutter-pypackage`_ project template.

.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

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

.. _measure coverage in out-of-process functional tests: http://coverage.readthedocs.io/en/coverage-4.3.4/subprocess.html

.. _pytest: https://docs.pytest.org/en/latest/

.. _Pylint: https://www.pylint.org/

.. _Tox: http://testrun.org/tox/