Merge pull request #29 from pyfar/apply-cookiecutter

Apply cookiecutter

Author: ahms5

.circleci/config.yml

@@ -171,36 +171,36 @@ workflows:
                 - "3.11"
                 - "3.12"
                 - "3.13"
-
+                
       - ruff:
           matrix:
             parameters:
               version:
-                - "3.12"
+                - "3.13"
           requires:
             - build_and_test
 
       - test_documentation_build:
           matrix:
             parameters:
               version:
-                - "3.12"
+                - "3.13"
           requires:
             - build_and_test
 
       - test_deprecation_warnings:
           matrix:
             parameters:
               version:
-                - "3.12"
+                - "3.13"
           requires:
             - build_and_test
 
       - test_pypi_publish:
           matrix:
             parameters:
               version:
-                - "3.12"
+                - "3.13"
           requires:
             - build_and_test
 
@@ -218,7 +218,7 @@ workflows:
                 - "3.11"
                 - "3.12"
                 - "3.13"
-
+                
           filters:
             branches:
               ignore: /.*/
@@ -230,7 +230,7 @@ workflows:
           matrix:
             parameters:
               version:
-                - "3.12"
+                - "3.13"
           requires:
             - build_and_test
           filters:
@@ -244,7 +244,7 @@ workflows:
           matrix:
             parameters:
               version:
-                - "3.12"
+                - "3.13"
           requires:
             - build_and_test
           filters:
@@ -258,7 +258,7 @@ workflows:
           matrix:
             parameters:
               version:
-                - "3.12"
+                - "3.13"
           requires:
             - build_and_test
           filters:
@@ -272,7 +272,7 @@ workflows:
           matrix:
             parameters:
               version:
-                - "3.12"
+                - "3.13"
           requires:
             - build_and_test
             - ruff

.github/ISSUE_TEMPLATE.md

@@ -3,7 +3,7 @@
 * imkar version:
 * Python version:
 * Operating System:
-* Did you install pyfar via pip:
+* Did you install imkar via pip:
 
 ## Description
 

.github/workflows/has_version_label.yml renamed to .github/workflows/has_label.yml

@@ -1,4 +1,4 @@
-name: PR Check Label for version Label
+name: pull_request label
 
 on:
   pull_request:
@@ -12,17 +12,15 @@ jobs:
   check-labels:
     runs-on: ubuntu-latest
     steps:
-      - name: Check for version label
+      - name: pull_request label
         run: |
-          echo "Checking for version label on pull request..."
+          echo "Checking for label on pull request..."
           PR_DATA=$(gh api repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }})
           LABEL_NAMES=$(echo "$PR_DATA" | jq -r '.labels[].name')
           echo "Labels: $LABEL_NAMES"
 
-          REGEX="^v[0-9]+\.[0-9]+\.[0-9]+$"
-          MATCHES=$(echo "$LABEL_NAMES" | grep -E "$REGEX")
-          if [ -z "$MATCHES" ]; then
-            echo "Error: No version label found on this pull request. Please add a label in the format vX.Y.Z."
+          if [ -z "$LABEL_NAMES" ]; then
+            echo "Error: No label found on this pull request. Please add a label."
             exit 1
           fi
         env:

.github/workflows/has_version_milestone.yml

@@ -0,0 +1,29 @@
+name: pull_request version milestone
+
+on:
+  pull_request:
+    types:
+      - opened
+      - labeled
+      - unlabeled
+      - synchronize
+
+jobs:
+  check-labels:
+    runs-on: ubuntu-latest
+    steps:
+      - name: pull_request version milestone
+        run: |
+          echo "Checking for version milestone on pull request..."
+          PR_DATA=$(gh api repos/${{ github.repository }}/pulls/${{ github.event.pull_request.number }})
+          MILESTONE_NAME=$(echo "$PR_DATA" | jq -r '.milestone.title')
+          echo "Milestone: $MILESTONE_NAME"
+
+          REGEX="^v[0-9]+\.[0-9]+\.[0-9]+$"
+          MATCHES=$(echo "$MILESTONE_NAME" | grep -E "$REGEX")
+          if [ -z "$MATCHES" ]; then
+            echo "Error: No version milestone found on this pull request. Please add a milestone in the format vX.Y.Z."
+            exit 1
+          fi
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024, The pyfar developers
+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

docs/conf.py

@@ -10,6 +10,7 @@
 import sys
 import urllib3
 import shutil
+import numpy as np
 sys.path.insert(0, os.path.abspath('..'))
 
 import imkar  # noqa
@@ -55,7 +56,7 @@
 
 # General information about the project.
 project = 'imkar'
-copyright = "2024, The pyfar developers"
+copyright = "2025, The pyfar developers"
 author = "The pyfar developers"
 
 # The version info for the project you're documenting, acts as replacement
@@ -117,7 +118,8 @@
     "navbar_start": ["navbar-logo"],
     "navbar_end": ["navbar-icon-links", "theme-switcher"],
     "navbar_align": "content",
-    "header_links_before_dropdown": 10,
+    "header_links_before_dropdown": None,  # will be automatically set later based on headers.rst
+    "header_dropdown_text": "Packages",  # Change dropdown name from "More" to "Packages"
     "icon_links": [
         {
           "name": "GitHub",
@@ -144,6 +146,15 @@
 }
 
 # -- download navbar and style files from gallery -----------------------------
+branch = 'main'
+link = f'https://github.com/pyfar/gallery/raw/{branch}/docs/'
+folders_in = [
+    '_static/css/custom.css',
+    '_static/favicon.ico',
+    '_static/header.rst',
+    'resources/logos/pyfar_logos_fixed_size_imkar.png',
+    ]
+
 def download_files_from_gallery(link, folders_in):
     c = urllib3.PoolManager()
     for file in folders_in:
@@ -155,14 +166,6 @@ def download_files_from_gallery(link, folders_in):
                 with open(filename, 'wb') as out_file:
                     shutil.copyfileobj(res, out_file)
 
-branch = 'main'
-link = f'https://github.com/pyfar/gallery/raw/{branch}/docs/'
-folders_in = [
-    '_static/css/custom.css',
-    '_static/favicon.ico',
-    '_static/header.rst',
-    'resources/logos/pyfar_logos_fixed_size_imkar.png',
-    ]
 download_files_from_gallery(link, folders_in)
 # if logo does not exist, use pyfar logo
 if not os.path.exists(html_logo):
@@ -179,5 +182,16 @@ def download_files_from_gallery(link, folders_in):
 
         fout.writelines(lines)
 
+        # add project to the list of projects if not in header
         if not contains_project:
             fout.write(f'   {project} <{project}>\n')
+        
+        # count the number of gallery headings
+        count_gallery_headings = np.sum(
+            ['https://pyfar-gallery.readthedocs.io' in line for line in lines])
+
+
+# set dropdown header after gallery headings
+html_theme_options['header_links_before_dropdown'] = count_gallery_headings+1
+
+

pyproject.toml

@@ -27,7 +27,7 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
-
+    
 ]
 dependencies = [
     'numpy',
@@ -50,6 +50,7 @@ tests = [
     "watchdog",
     "ruff==0.8.3",
     "coverage",
+    
 ]
 docs = [
     "sphinx",