cookiecutter for pyfar pypackages

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 cookiecutter-pypackage <https://github.com/audreyfeldroy/cookiecutter-pypackage>_.

Free software: BSD license

Getting Started

The pyfar workshop gives an overview of the most important pyfar functionality and is a good starting point. It is part of the pyfar example gallery that also contains more specific and in-depth examples that can be executed interactively without a local installation by clicking the mybinder.org button on the respective example. The pyfar documentation gives a detailed and complete overview of pyfar. All these information are available from pyfar.org.

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

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

Then:

• Create a repo and put it there.
• Add the repo to your Circleci account.
• Add the repo to your Read the Docs account + turn on the Read the Docs service hook and activate it for pull requests.
• Release your package using bump-my-version (see Contributing).
• Activate your project on pypi.org.

For more details, see the cookiecutter-pypackage tutorial.

Contributing

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