lint

.github/workflows/publish.yml

@@ -9,14 +9,14 @@ jobs:
     name: Publish to PyPI
     runs-on: ubuntu-latest
     permissions:
-      contents: 'read'
-      id-token: 'write'
+      contents: "read"
+      id-token: "write"
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: '3.x'
+          python-version: "3.x"
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip build twine
@@ -32,4 +32,4 @@ jobs:
         with:
           password: ${{ secrets.pypi_token }}
           repository_url: https://upload.pypi.org/legacy/
-          verify_metadata: true
+          verify_metadata: true

docs/api.rst

@@ -8,4 +8,3 @@ API reference
 
     .. autoclass:: Sentinel1Reader
         :members:
-

docs/conf.py

@@ -16,16 +16,16 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autosummary',
-    'sphinx.ext.autodoc',
+    "sphinx.ext.autosummary",
+    "sphinx.ext.autodoc",
     "myst_parser",
     "sphinx.ext.extlinks",
     "sphinx.ext.intersphinx",
     "IPython.sphinxext.ipython_directive",
     "IPython.sphinxext.ipython_console_highlighting",
-    'nbsphinx',
-    'jupyter_sphinx',
-    'sphinx.ext.napoleon'
+    "nbsphinx",
+    "jupyter_sphinx",
+    "sphinx.ext.napoleon",
 ]
 
 extlinks = {
@@ -36,9 +36,9 @@
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
-html_style = 'css/xsar.css'
+html_style = "css/xsar.css"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -84,21 +84,21 @@
     "dask": ("https://docs.dask.org/en/latest", None),
     "xarray": ("https://docs.xarray.dev/en/latest/", None),
     "rasterio": ("https://rasterio.readthedocs.io/en/latest/", None),
-    "datatree": ("https://xarray-datatree.readthedocs.io/en/latest/", None)
+    "datatree": ("https://xarray-datatree.readthedocs.io/en/latest/", None),
 }
 
 html_theme_options = {
-    'navigation_depth': 4,  # FIXME: doesn't work as expeted: should expand side menu
-    'collapse_navigation': False # FIXME: same as above
+    "navigation_depth": 4,  # FIXME: doesn't work as expeted: should expand side menu
+    "collapse_navigation": False,  # FIXME: same as above
 }
 
 # If true, links to the reST sources are added to the pages.
 html_show_sourcelink = False
 
 nbsphinx_allow_errors = False
 
-nbsphinx_execute = 'always'
+nbsphinx_execute = "always"
 
 nbsphinx_timeout = 300
 
-today_fmt = '%b %d %Y at %H:%M'
+today_fmt = "%b %d %Y at %H:%M"

docs/index.rst

@@ -79,4 +79,4 @@ Last documentation build: |today|
 .. _xarray.Dataset: http://xarray.pydata.org/en/stable/generated/xarray.Dataset.html
 .. _`recommended installation`: installing.rst#recommended-packages
 .. _SAFE format: https://sentinel.esa.int/web/sentinel/user-guides/sentinel-1-sar/data-formats
-.. _jupyter notebook: https://jupyter.readthedocs.io/en/latest/running.html#running
+.. _jupyter notebook: https://jupyter.readthedocs.io/en/latest/running.html#running

docs/installing.rst

@@ -45,4 +45,4 @@ Pytest configuration
 Pytest uses a default configuration file (`config.yml`) in which we can found products paths to test.
 This configuration can be superseded by adding a local config file on the home directory :
 (`~/xarray-safe-s1/localconfig.yml`).
-In this file, testing files can be listed in the var `product_paths`.
+In this file, testing files can be listed in the var `product_paths`.

pyproject.toml

@@ -69,4 +69,4 @@ known-third-party = ["xarray", "toolz", "construct"]
 
 [tool.ruff.lint.flake8-tidy-imports]
 # Disallow all relative imports.
-ban-relative-imports = "all"
+ban-relative-imports = "all"

safe_s1/__init__.py

@@ -1,12 +1,11 @@
 import traceback
-#import safe_s1
-from safe_s1.reader import Sentinel1Reader
+
 try:
     from importlib import metadata
-except ImportError: # for Python<3.8
+except ImportError:  # for Python<3.8
     import importlib_metadata as metadata
-try: 
+try:
     __version__ = metadata.version("xarray-safe-s1")
 except Exception:
-    print('trace',traceback.format_exc())
+    print("trace", traceback.format_exc())
     __version__ = "999"

safe_s1/config.yml

@@ -1,3 +1,3 @@
 # default data paths for tests
 product_paths:
-  - 'S1A_IW_GRDH_1SDV_20170907T103020_20170907T103045_018268_01EB76_Z010.SAFE'
+  - "S1A_IW_GRDH_1SDV_20170907T103020_20170907T103045_018268_01EB76_Z010.SAFE"

safe_s1/getconfig.py

@@ -1,23 +1,30 @@
-import yaml
-import os
 import logging
-import safe_s1
+import os
 from pathlib import Path
+
+import yaml
+
+import safe_s1
+
+
 # determine the config file we will use (config.yml by default, and a local config if one is present) and retrieve
 # the products names
 def get_config():
-    local_config_pontential_path = os.path.join(os.path.dirname(safe_s1.__file__), 'localconfig.yml')
-    logging.info('potential local config: %s',local_config_pontential_path)
-    #local_config_pontential_path = Path(os.path.join('~', 'xarray-safe-s1', 'localconfig.yml')).expanduser()
+    local_config_pontential_path = os.path.join(
+        os.path.dirname(safe_s1.__file__), "localconfig.yml"
+    )
+    logging.info("potential local config: %s", local_config_pontential_path)
+    # local_config_pontential_path = Path(os.path.join('~', 'xarray-safe-s1', 'localconfig.yml')).expanduser()
     if os.path.exists(local_config_pontential_path):
-        logging.info('localconfig used')
+        logging.info("localconfig used")
         config_path = local_config_pontential_path
         with open(config_path) as config_content:
             conf = yaml.load(config_content, Loader=yaml.SafeLoader)
     else:
-        logging.info('default config')
-        config_path = Path(os.path.join(os.path.dirname(safe_s1.__file__), 'config.yml'))
+        logging.info("default config")
+        config_path = Path(
+            os.path.join(os.path.dirname(safe_s1.__file__), "config.yml")
+        )
         with open(config_path) as config_content:
             conf = yaml.load(config_content, Loader=yaml.SafeLoader)
     return conf
-