Release sofar 1.2.0

.circleci/config.yml

@@ -45,7 +45,7 @@ jobs:
           name: Run tests
           command: git submodule sync --recursive && git submodule update --recursive --init && pytest
 
-  flake:
+  ruff:
     parameters:
       version:
         description: "version tag"
@@ -63,7 +63,7 @@ jobs:
           pip-dependency-file: requirements_dev.txt
       - run:
           name: Flake8
-          command: git submodule sync --recursive && git submodule update --recursive --init && flake8 sofar tests
+          command: git submodule sync --recursive && git submodule update --recursive --init && ruff check
 
   test_documentation_build:
     parameters:
@@ -132,7 +132,7 @@ workflows:
                 - "3.10"
                 - "3.11"
                 - "3.12"
-      - flake:
+      - ruff:
           matrix:
             parameters:
               version:
@@ -168,7 +168,7 @@ workflows:
             tags:
               only: /^v[0-9]+(\.[0-9]+)*$/
 
-      - flake:
+      - ruff:
           matrix:
             parameters:
               version:
@@ -203,7 +203,7 @@ workflows:
                 - "3.12"
           requires:
             - build_and_test
-            - flake
+            - ruff
             - test_documentation_build
           filters:
             branches:

.editorconfig

@@ -1,13 +1,24 @@
-# see http://editorconfig.org
+# http://editorconfig.org
+
 root = true
 
 [*]
-end_of_line = lf
-trim_trailing_whitespace = true
-insert_final_newline = true
 indent_style = space
 indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
 charset = utf-8
+end_of_line = lf
+
+[*.yml]
+indent_size = 2
 
-[*.{bat,cmd,ps1}]
+[*.bat]
+indent_style = tab
 end_of_line = crlf
+
+[LICENSE]
+insert_final_newline = false
+
+[Makefile]
+indent_style = tab

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,18 @@
+## General
+
+* sofar version:
+* Python version:
+* Operating System:
+* Did you install pyfar via pip:
+
+## Description
+
+Describe what you were trying to get done.
+Tell us what happened, what went wrong, and what you expected to happen.
+
+## What I Did
+
+```
+Paste the command(s) you ran and the output.
+If there was a crash, please include the traceback here.
+```

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,9 @@
+### Which issue(s) are closed by this pull request?
+
+Closes #
+
+### Changes proposed in this pull request:
+
+-
+-
+-

.github/workflows/create_issue_if_cookiecutter.yml

@@ -0,0 +1,25 @@
+on:
+  pull_request:
+    types: [ labeled ]
+name: Create issue if pr gets a cookiecutter label
+jobs:
+  stuff:
+    permissions:
+      contents: read
+      issues: write
+    name: create issue
+    environment: test
+    if: github.event.label.name == 'cookiecutter'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          repository: 'pyfar/cookiecutter-pypackage'
+      - uses: dacbd/create-issue-action@v2
+        with:
+          title: ${{ github.event.pull_request.title  }}
+          token: ${{ secrets.cookiecutter_PAT }}
+          owner: pyfar
+          repo: cookiecutter-pypackage
+          body: |
+            apply changes from https://github.com/${{ github.repository }}/pull/${{ github.event.number }}

.gitignore

@@ -1,71 +1,124 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
 *.py[cod]
+*$py.class
 
 # C extensions
 *.so
 
-# Packages
-*.egg
-*.egg-info
-dist
-build
-eggs
-.eggs
-parts
-bin
-var
-sdist
-wheelhouse
-develop-eggs
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
 .installed.cfg
-lib
-lib64
-venv*/
-env/
-pyvenv*/
-.pytest_cache/
-**/__pycache__/
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
 
 # Installer logs
 pip-log.txt
+pip-delete-this-directory.txt
 
 # Unit test / coverage reports
+htmlcov/
 .coverage
-.tox
 .coverage.*
+.cache
 nosetests.xml
 coverage.xml
-htmlcov
+*.cover
+.hypothesis/
+.pytest_cache/
 
 # Translations
 *.mo
+*.pot
 
-# Mr Developer
-.mr.developer.cfg
-.project
-.pydevproject
-.idea
-*.iml
-*.komodoproject
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
 
-# Complexity
-output/*.html
-output/*/index.html
+# Flask stuff:
+instance/
+.webassets-cache
 
-# Sphinx
-docs/_build
+# Scrapy stuff:
+.scrapy
 
-.DS_Store
-.vscode
-*~
-.*.sw[po]
-.build
-.ve
+# Sphinx documentation
+docs/_build/
+docs/_autosummary
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+*/.ipynb_checkpoints/*
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
 .env
-.cache
-.pytest
-.bootstrap
-.appveyor.token
-*.bak
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# vs code
+.vscode/
+.idea/
+
+# macOS
+.DS_Store
+
+# workaround for failing test discovery in vscode
+tests/*/__init__.py
+tests/private/
 
-# Private tests
-tests/private
+# ignore downloads from pyfar gallery
+docs/header.rst
+docs/_static/favicon.ico
+docs/_static/header.rst
+docs/_static/css/custom.css
+docs/resources/logos/pyfar_logos_fixed_size_sofar.png
+docs/resources/conventions.rst