Migrate to copier

Author: ahms5

.circleci/config.yml

@@ -36,13 +36,13 @@ jobs:
       version: <<parameters.version>>
     steps:
       - checkout
-      
+            
       - run:
           name: install dependencies
           command: pip install ".[tests]"
       - run:
           name: Run tests
-          command: pytest
+          command: pytest tests
 
   ruff:
     parameters:
@@ -102,7 +102,7 @@ jobs:
           name: Run tests
           command: pytest tests -W error::DeprecationWarning
 
-  test_pypi_publish:
+  test_package_build:
     parameters:
       version:
         description: "version tag"
@@ -145,6 +145,7 @@ jobs:
             twine check dist/*
             twine upload dist/*
 
+
 # Invoke jobs via workflows
 # See: https://circleci.com/docs/2.0/configuration-reference/#workflows
 workflows:
@@ -155,101 +156,46 @@ workflows:
           matrix:
             parameters:
               version:
-                - "3.10"
                 - "3.11"
                 - "3.12"
                 - "3.13"
+                - "3.14"
 
       - ruff:
           matrix:
             parameters:
               version:
-                - "3.13"
+                - "3.14"
           requires:
             - build_and_test
 
       - test_documentation_build:
           matrix:
             parameters:
               version:
-                - "3.13"
+                - "3.14"
           requires:
             - build_and_test
 
       - test_deprecation_warnings:
           matrix:
             parameters:
               version:
-                - "3.13"
-          requires:
-            - build_and_test
-
-      - test_pypi_publish:
-          matrix:
-            parameters:
-              version:
-                - "3.13"
+                - "3.14"
           requires:
             - build_and_test
 
-  test_and_publish:
-    # Test and publish on new git version tags
-    # This requires its own workflow to successfully trigger the test and build
-    jobs:
-      - build_and_test:
-          matrix:
-            parameters:
-              version:
-                - "3.10"
-                - "3.11"
-                - "3.12"
-                - "3.13"
-                
-          filters:
-            branches:
-              ignore: /.*/
-            # only act on version tags
-            tags:
-              only: /^v[0-9]+(\.[0-9]+)*$/
-
-      - ruff:
+      - test_package_build:
           matrix:
             parameters:
               version:
-                - "3.13"
+                - "3.14"
           requires:
             - build_and_test
           filters:
             branches:
-              ignore: /.*/
-            # only act on version tags
-            tags:
-              only: /^v[0-9]+(\.[0-9]+)*$/
+              only:
+                - main
+                - develop
 
-      - test_documentation_build:
-          matrix:
-            parameters:
-              version:
-                - "3.13"
-          requires:
-            - build_and_test
-          filters:
-            branches:
-              ignore: /.*/
-            # only act on version tags
-            tags:
-              only: /^v[0-9]+(\.[0-9]+)*$/
 
-      - test_deprecation_warnings:
-          matrix:
-            parameters:
-              version:
-                - "3.13"
-          requires:
-            - build_and_test
-          filters:
-            branches:
-              ignore: /.*/
-            # only act on version tags
-            tags:
-              only: /^v[0-9]+(\.[0-9]+)*$/

.copier-answers.yml

@@ -0,0 +1,32 @@
+# Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
+_commit: de4749b
+_src_path: https://github.com/pyfar/template-pyfar-package
+add_submodules: false
+additional_section_readme: ''
+apt_packages: ''
+author: The pyfar developers
+copyright_statement: 2025, The pyfar developers
+dependencies: copier,numpy
+docs_custom_import: ''
+git_username: pyfar
+gitignore_custom: ''
+intersphinx_mapping: []
+keywords: acoustics,pyfar,copier,template
+license: MIT
+logo_path_gallery: resources/logos/pyfar_logos_fixed_size_pyfar.png
+manifest_custom: ''
+minimum_python_version: '3.11'
+project_getting_started: "\n1. To use this template, first install copier with pip.\n\
+    \n    ```console\n    pip install copier\n    ```\n\n2. Run the following copier\
+    \ command to create a target directory at path_to_target_folder.\n   Note: Copier\
+    \ will overwrite files in the given directory if it already exists.\n\n    ```console\n\
+    \    copier copy https://github.com/pyfar/template-pyfar-package path_to_target_folder\n\
+    \    ```\n"
+project_installation_instructions: ''
+project_long_description: 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/).
+project_short_description: Template to generate and update pyfar packages.
+project_slug: template-pyfar-package
+ruff_ignore: .git,docs
+use_pypi_deployment_with_ci: false
+version: 0.1.0

.github/workflows/check_modified_history.yml

@@ -0,0 +1,26 @@
+name : modified_history_check
+
+on :
+  pull_request:
+    types:
+      - opened
+      - synchronize
+
+jobs:
+  check-history:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Check if HISTORY.rst was modified or created
+        run: |
+          git diff origin/${{ github.base_ref }} HEAD \
+            --diff-filter=AMR \
+            --name-only \
+            -- HISTORY.rst | grep -q . || {
+              echo "ERROR: HISTORY.rst was not modified"
+              exit 1
+            }
+

.github/workflows/has_version_milestone.yml

@@ -4,8 +4,8 @@ on:
   pull_request:
     types:
       - opened
-      - labeled
-      - unlabeled
+      - milestoned
+      - demilestoned
       - synchronize
 
 jobs:

.gitignore

@@ -123,3 +123,6 @@ docs/_static/css/custom.css
 docs/_static/js/custom.js
 docs/resources/logos/pyfar_logos_fixed_size_pyfar.png
 docs/resources/logos/pyfar_logos_fixed_size_pyfar.png
+
+# custom
+

.readthedocs.yml

@@ -1,25 +1,28 @@
 # .readthedocs.yml
-# Read the Docs configuration file
+# Read the Docs configuration file for Sphinx projects
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 
 # Required
 version: 2
 
+# Set the OS, Python version and other tools you might need
 build:
-  os: ubuntu-22.04
+  os: ubuntu-24.04
   tools:
-    python: "3.13"
-  
+    python: 3.14
 
-# Build documentation in the docs/ directory with Sphinx
+
+# Build documentation in the "docs/" directory with Sphinx
 sphinx:
   configuration: docs/conf.py
 
-# Optionally build your docs in additional formats such as PDF
+# Optionally build your docs in additional formats such as PDF and ePub
 formats:
   - pdf
 
-# Optionally set the version of Python and requirements required to build your docs
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 python:
   install:
     - method: pip

CONTRIBUTING.rst

@@ -6,7 +6,7 @@ Contributing
 
 Contributions are welcome, and they are greatly appreciated! Every little bit
 helps, and credit will always be given. The following helps you to start
-contributing specifically to template_pyfar_package. Please also consider the
+contributing specifically to template-pyfar-package. Please also consider the
 `general contributing guidelines`_ for example regarding the style
 of code and documentation and some helpful hints.
 
@@ -16,36 +16,38 @@ Types of Contributions
 Report Bugs or Suggest Features
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The best place for this is https://github.com/pyfar/template_pyfar_package/issues.
+The best place for this is https://github.com/pyfar/template-pyfar-package/issues.
 
 Fix Bugs or Implement Features
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Look through https://github.com/pyfar/template_pyfar_package/issues for bugs or feature request
+Look through https://github.com/pyfar/template-pyfar-package/issues for bugs or feature requests
 and contact us or comment if you are interested in implementing.
 
 Write Documentation
 ~~~~~~~~~~~~~~~~~~~
 
-template_pyfar_package could always use more documentation, whether as part of the
-official template_pyfar_package docs, in docstrings, or even on the web in blog posts,
+template-pyfar-package could always use more documentation, whether as part of the
+official template-pyfar-package docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
 Get Started!
 ------------
 
-Ready to contribute? Here's how to set up `template_pyfar_package` for local development using the command-line interface. Note that several alternative user interfaces exist, e.g., the Git GUI, `GitHub Desktop <https://desktop.github.com/>`_, extensions in `Visual Studio Code <https://code.visualstudio.com/>`_ ...
+Ready to contribute? Here's how to set up `template-pyfar-package` for local development using the command-line interface.
+Note that several alternative user interfaces exist, e.g., the Git GUI, `GitHub Desktop <https://desktop.github.com/>`_,
+extensions in `Visual Studio Code <https://code.visualstudio.com/>`_ ...
 
-1. `Fork <https://docs.github.com/en/get-started/quickstart/fork-a-repo/>`_ the `template_pyfar_package` repo on GitHub.
-2. Clone your fork locally and cd into the template_pyfar_package directory::
+1. `Fork <https://docs.github.com/en/get-started/quickstart/fork-a-repo/>`_ the `template-pyfar-package` repo on GitHub.
+2. Clone your fork locally and cd into the template-pyfar-package directory::
 
-    $ git clone https://github.com/YOUR_USERNAME/template_pyfar_package.git
-    $ cd template_pyfar_package
+    $ git clone https://github.com/YOUR_USERNAME/template-pyfar-package.git
+    $ cd template-pyfar-package
 
 3. Install your local copy into a virtualenv. Assuming you have Anaconda or Miniconda installed, this is how you set up your fork for local development::
 
-    $ conda create --name template_pyfar_package python
-    $ conda activate template_pyfar_package
+    $ conda create --name template-pyfar-package python
+    $ conda activate template-pyfar-package
     $ pip install -e ".[dev]"
 
 4. Create a branch for local development. Indicate the intention of your branch in its respective name (i.e. `feature/branch-name` or `bugfix/branch-name`)::
@@ -60,7 +62,8 @@ Ready to contribute? Here's how to set up `template_pyfar_package` for local dev
     $ ruff check
     $ pytest
 
-   ruff must pass without any warnings for `./template_pyfar_package` and `./tests` using the default or a stricter configuration. Ruff ignores a couple of PEP Errors (see `./pyproject.toml`). If necessary, adjust your linting configuration in your IDE accordingly.
+   ruff must pass without any warnings for `./template-pyfar-package` and `./tests` using the default or a stricter
+   configuration. Ruff ignores a couple of PEP Errors (see `./pyproject.toml`). If necessary, adjust your linting configuration in your IDE accordingly.
 
 6. Commit your changes and push your branch to GitHub::
 
@@ -70,5 +73,4 @@ Ready to contribute? Here's how to set up `template_pyfar_package` for local dev
 
 7. Submit a pull request on the develop branch through the GitHub website.
 
-
 .. _general contributing guidelines: https://pyfar-gallery.readthedocs.io/en/latest/contribute/index.html

HISTORY.rst

@@ -2,7 +2,27 @@
 History
 =======
 
-0.1.0 (2025-11-01)
+[Unreleased]
+------------
+
+Added
+^^^^^
+
+Changed
+^^^^^^^
+
+Deprecated
+^^^^^^^^^^
+
+Removed
+^^^^^^^
+
+Fixed
+^^^^^
+
+0.1.0 (2026-04-16)
 ------------------
 
+Added
+^^^^^
 * First release on PyPI.

LICENSE

@@ -1,22 +1,21 @@
-MIT License
+The MIT License (MIT)
 
 Copyright (c) 2025, The pyfar developers
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice (including the next
+paragraph) shall be included in all copies or substantial portions of the
+Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.