https://github.com/pyfar/template-pyfar-package

Copier template to generate and update pyfar packages.
https://github.com/pyfar/template-pyfar-package

Last synced: 4 months ago
JSON representation

Copier template to generate and update pyfar packages.

• Host: GitHub
• URL: https://github.com/pyfar/template-pyfar-package
• Owner: pyfar
• License: mit
• Created: 2025-11-01T12:26:03.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2026-03-31T13:29:38.000Z (4 months ago)
• Last Synced: 2026-03-31T15:27:40.270Z (4 months ago)
• Language: Jinja
• Homepage: https://template-pyfar-package.readthedocs.io/
• Size: 78.1 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

          





# Template for pyfar packages

[![PyPI version](https://badge.fury.io/py/template_pyfar_package.svg)](https://badge.fury.io/py/template_pyfar_package)

[![Documentation Status](https://readthedocs.org/projects/template-pyfar-package/badge/?version=latest)](https://template-pyfar-package.readthedocs.io/en/latest/?badge=latest)

[![CircleCI](https://circleci.com/gh/pyfar/template-pyfar-package.svg?style=shield)](https://circleci.com/gh/pyfar/template-pyfar-package)

[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/pyfar_introduction.ipynb)

## Overview

This template is used to keep all pyfar packages consistent and provide a good staring point for new packages. It uses [copier](https://copier.readthedocs.io/en/stable/).

## Installation

1. To use this template, first install copier with pip.

    ```console

    pip install copier

    ```

2. Run the following copier command to create a target directory at path_to_target_folder.

   Note: Copier will overwrite files in the given directory if it already exists.

    ```console

    copier copy https://github.com/pyfar/template-pyfar-package path_to_target_folder

    ```

(Requires Python 3.10 or higher)

## Contributing

Check out the [contributing guidelines](https://pyfar.readthedocs.io/en/stable/contributing.html) if you want to become part of pyfar.