sofar 1.2.1__tar.gz → 1.2.2__tar.gz

{sofar-1.2.1 → sofar-1.2.2}/HISTORY.rst

@@ -2,6 +2,11 @@
 History
 =======
 
+1.2.2 (2025-05-09)
+------------------
+* Docs: Improve layout of header (#125)
+* Deployment: Add missing dependency for `packaging` package and support for Python 3.13  (PR #125, #127)
+
 1.2.1 (2024-12-12)
 ------------------
 * Deployment: Move from setup.py to pyproject.toml (PR #114, #115)

{sofar-1.2.1 → sofar-1.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: sofar
-Version: 1.2.1
+Version: 1.2.2
 Summary: Maybe the most complete python package for SOFA files so far.
 Author-email: The pyfar developers <info@pyfar.org>
 License: MIT License
@@ -43,6 +43,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -50,6 +51,7 @@ Requires-Dist: netCDF4
 Requires-Dist: numpy>=1.14.0
 Requires-Dist: beautifulsoup4
 Requires-Dist: requests
+Requires-Dist: packaging
 Provides-Extra: deploy
 Requires-Dist: twine; extra == "deploy"
 Requires-Dist: wheel; extra == "deploy"
@@ -72,6 +74,7 @@ Requires-Dist: sphinx-favicon; extra == "docs"
 Requires-Dist: sphinx-reredirects; extra == "docs"
 Provides-Extra: dev
 Requires-Dist: sofar[deploy,docs,tests]; extra == "dev"
+Dynamic: license-file
 
 <h1 align="center">
 <img src="https://github.com/pyfar/gallery/raw/main/docs/resources/logos/pyfar_logos_fixed_size_sofar.png" width="300">

{sofar-1.2.1 → sofar-1.2.2}/docs/conf.py

@@ -10,6 +10,7 @@ import os
 import sys
 import urllib3
 import shutil
+import numpy as np
 sys.path.insert(0, os.path.abspath('..'))
 
 import sofar
@@ -117,7 +118,8 @@ html_theme_options = {
     "navbar_start": ["navbar-logo"],
     "navbar_end": ["navbar-icon-links", "theme-switcher"],
     "navbar_align": "content",
-    "header_links_before_dropdown": 8,
+    "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",
@@ -152,16 +154,44 @@ folders_in = [
     '_static/header.rst',
     'resources/logos/pyfar_logos_fixed_size_sofar.png',
     ]
-c = urllib3.PoolManager()
-for file in folders_in:
-    url = link + file
-    filename = file
-    os.makedirs(os.path.dirname(filename), exist_ok=True)
-    with c.request('GET', url, preload_content=False) as res, open(filename, 'wb') as out_file:
-        shutil.copyfileobj(res, out_file)
+
+def download_files_from_gallery(link, folders_in):
+    c = urllib3.PoolManager()
+    for file in folders_in:
+        url = link + file
+        filename = file
+        os.makedirs(os.path.dirname(filename), exist_ok=True)
+        with c.request('GET', url, preload_content=False) as res:
+            if res.status == 200:
+                with open(filename, 'wb') as out_file:
+                    shutil.copyfileobj(res, out_file)
+
+download_files_from_gallery(link, folders_in)
+# if logo does not exist, use pyfar logo
+if not os.path.exists(html_logo):
+    download_files_from_gallery(
+        link, ['resources/logos/pyfar_logos_fixed_size_pyfar.png'])
+    shutil.copyfile(
+        'resources/logos/pyfar_logos_fixed_size_pyfar.png', html_logo)
 
 # replace sofar hard link to internal link
 with open("_static/header.rst", "rt") as fin:
     with open("header.rst", "wt") as fout:
-        for line in fin:
-            fout.write(line.replace(f'https://{project}.readthedocs.io', project))
+        lines = [line.replace(f'https://{project}.readthedocs.io', project) for line in fin]
+        contains_project = any(project in line for line in lines)
+
+        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
+
+

{sofar-1.2.1 → sofar-1.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "sofar"
-version = "1.2.1"
+version = "1.2.2"
 description = "Maybe the most complete python package for SOFA files so far."
 readme = "README.md"
 license = {file = "LICENSE"}
@@ -23,12 +23,14 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
 ]
 dependencies = [
     'netCDF4',
     'numpy>=1.14.0',
     'beautifulsoup4',
     'requests',
+    'packaging',
 ]
 
 [project.optional-dependencies]
@@ -122,8 +124,9 @@ lint.select = [
 [tool.ruff.lint.pydocstyle]
 convention = "numpy"
 
+
 [tool.bumpversion]
-current_version = "1.2.1"
+current_version = "1.2.2"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = ["{major}.{minor}.{patch}"]
 search = "{current_version}"

{sofar-1.2.1 → sofar-1.2.2}/sofar/__init__.py

@@ -2,7 +2,7 @@
 # -*- coding: utf-8 -*-
 __author__ = """The pyfar developers"""
 __email__ = 'info@pyfar.org'
-__version__ = '1.2.1'
+__version__ = '1.2.2'
 
 from .sofa import Sofa
 

{sofar-1.2.1 → sofar-1.2.2}/sofar/io.py

@@ -234,8 +234,8 @@ def write_sofa(filename: str, sofa: sf.Sofa, compression=4):
         The SOFA object that is written to disk
     compression : int
         The level of compression with ``0`` being no compression and ``9``
-        being the best compression. The default of ``9`` optimizes the file
-        size but increases the time for writing files to disk.
+        being the best compression. The default ``4`` is a tradeoff between
+        file size and the time required for reading and writing the file.
 
     Notes
     -----

{sofar-1.2.1 → sofar-1.2.2}/sofar.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: sofar
-Version: 1.2.1
+Version: 1.2.2
 Summary: Maybe the most complete python package for SOFA files so far.
 Author-email: The pyfar developers <info@pyfar.org>
 License: MIT License
@@ -43,6 +43,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -50,6 +51,7 @@ Requires-Dist: netCDF4
 Requires-Dist: numpy>=1.14.0
 Requires-Dist: beautifulsoup4
 Requires-Dist: requests
+Requires-Dist: packaging
 Provides-Extra: deploy
 Requires-Dist: twine; extra == "deploy"
 Requires-Dist: wheel; extra == "deploy"
@@ -72,6 +74,7 @@ Requires-Dist: sphinx-favicon; extra == "docs"
 Requires-Dist: sphinx-reredirects; extra == "docs"
 Provides-Extra: dev
 Requires-Dist: sofar[deploy,docs,tests]; extra == "dev"
+Dynamic: license-file
 
 <h1 align="center">
 <img src="https://github.com/pyfar/gallery/raw/main/docs/resources/logos/pyfar_logos_fixed_size_sofar.png" width="300">

{sofar-1.2.1 → sofar-1.2.2}/sofar.egg-info/requires.txt

@@ -2,6 +2,7 @@ netCDF4
 numpy>=1.14.0
 beautifulsoup4
 requests
+packaging
 
 [deploy]
 twine