Getting Started#

cookiecutter for pyfar pypackages#

Documentation Status CircleCI

Cookiecutter template for pyfar Python packages.

This template is used to keep all pyfar packages consistent and to provide a good starting point for new packages. It is forked from audreyfeldroy/cookiecutter-pypackage.

Free software: BSD license

Quickstart#

Install the latest Cookiecutter if you haven’t installed it yet (this requires Cookiecutter 1.4.0 or higher)

pip install -U cookiecutter

Generate a Python package project in a local folder

cookiecutter https://github.com/pyfar/cookiecutter-pypackage.git

For more details, including setting up automatic testing on CircleCI, publishing on pypi and documentation build on readthedocs, see the cookiecutter-pypackage tutorial.

Contributing#

Check out the contributing guidelines if you want to become part of pyfar.