Merge pull request #86 from StagPython/packaging

Packaging

Author: amorison

.github/workflows/tox.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        py: ['3.8', '3.9', '3.10']
+        py: ['3.8', '3.9', '3.10', '3.11']
 
     steps:
       - uses: actions/checkout@v3
@@ -28,6 +28,6 @@ jobs:
       - name: Update pip
         run: python -m pip install -U pip
       - name: Install tox-gh
-        run: python3 -m pip install tox-gh==0.0.4 tox==4.0.0b2
+        run: python3 -m pip install tox-gh>=1.0.0 tox==4.4.2
       - name: Run tox
         run: tox run

pyproject.toml

@@ -25,6 +25,7 @@ classifiers = [
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
 ]
 requires-python = ">=3.8"
 dependencies = [
@@ -65,3 +66,7 @@ module = [
     "scipy.*",
 ]
 ignore_missing_imports = true
+
+[tool.isort]
+profile = "black"
+multi_line_output = 3

stagpy/__init__.py

@@ -17,6 +17,7 @@
 """
 
 from __future__ import annotations
+
 import importlib.resources as imlr
 import os
 import shutil
@@ -26,20 +27,20 @@
 
 from setuptools_scm import get_version
 
-from . import config, _styles
+from . import _styles, config
 
 if typing.TYPE_CHECKING:
-    from typing import NoReturn, Any, Iterator
+    from typing import Any, Iterator, NoReturn
 
 
 def _env(var: str) -> bool:
     """Return whether var is set to True."""
-    val = os.getenv(var, default='').lower()
-    return val in ('true', 't', 'yes', 'y', 'on', '1')
+    val = os.getenv(var, default="").lower()
+    return val in ("true", "t", "yes", "y", "on", "1")
 
 
-DEBUG = _env('STAGPY_DEBUG')
-ISOLATED = _env('STAGPY_ISOLATED')
+DEBUG = _env("STAGPY_DEBUG")
+ISOLATED = _env("STAGPY_ISOLATED")
 
 
 def sigint_handler(*_: Any) -> NoReturn:
@@ -48,7 +49,7 @@ def sigint_handler(*_: Any) -> NoReturn:
     It is set when you use StagPy as a command line tool to handle gracefully
     keyboard interruption.
     """
-    print('\nSo long, and thanks for all the fish.')
+    print("\nSo long, and thanks for all the fish.")
     sys.exit()
 
 
@@ -61,7 +62,7 @@ def _iter_styles() -> Iterator[str]:
 def _check_config() -> None:
     """Create config files as necessary."""
     config.CONFIG_DIR.mkdir(parents=True, exist_ok=True)
-    verfile = config.CONFIG_DIR / '.version'
+    verfile = config.CONFIG_DIR / ".version"
     uptodate = verfile.is_file() and verfile.read_text() == __version__
     if not uptodate:
         verfile.write_text(__version__)
@@ -75,13 +76,17 @@ def _check_config() -> None:
 
 
 if DEBUG:
-    print('StagPy runs in DEBUG mode because the environment variable',
-          'STAGPY_DEBUG is set to "True"', sep='\n', end='\n\n')
+    print(
+        "StagPy runs in DEBUG mode because the environment variable",
+        'STAGPY_DEBUG is set to "True"',
+        sep="\n",
+        end="\n\n",
+    )
 else:
     _PREV_INT = signal.signal(signal.SIGINT, sigint_handler)
 
 try:
-    __version__ = get_version(root='..', relative_to=__file__)
+    __version__ = get_version(root="..", relative_to=__file__)
 except LookupError:
     try:
         from ._version import version as __version__

stagpy/__main__.py

@@ -11,20 +11,27 @@ def main() -> None:
     """Implement StagPy entry point."""
     if not DEBUG:
         signal.signal(signal.SIGINT, sigint_handler)
-        warnings.simplefilter('ignore')
+        warnings.simplefilter("ignore")
     from . import args, error
+
     try:
         args.parse_args()()
     except error.StagpyError as err:
         if DEBUG:
             raise
         errtype = type(err).__name__
-        print('Oops! StagPy encountered the following problem while '
-              'processing your request.', 'Please check the path to your '
-              'simulation and the command line arguments.', '',
-              f'{errtype}: {err}', sep='\n', file=sys.stderr)
+        print(
+            "Oops! StagPy encountered the following problem while "
+            "processing your request.",
+            "Please check the path to your "
+            "simulation and the command line arguments.",
+            "",
+            f"{errtype}: {err}",
+            sep="\n",
+            file=sys.stderr,
+        )
         sys.exit()
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     main()

stagpy/_helpers.py

@@ -10,7 +10,8 @@
 from . import conf
 
 if typing.TYPE_CHECKING:
-    from typing import Optional, Any
+    from typing import Any, Optional
+
     from matplotlib.figure import Figure
     from numpy import ndarray
 
@@ -31,8 +32,8 @@ def out_name(stem: str, timestep: Optional[int] = None) -> str:
     if conf.core.shortname:
         return conf.core.outname
     if timestep is not None:
-        stem = f'{stem}{timestep:05d}'
-    return conf.core.outname + '_' + stem
+        stem = f"{stem}{timestep:05d}"
+    return conf.core.outname + "_" + stem
 
 
 def scilabel(value: float, precision: int = 2) -> str:
@@ -47,13 +48,14 @@ def scilabel(value: float, precision: int = 2) -> str:
     Returns:
         the scientific notation of the specified value.
     """
-    man, exps = f'{value:.{precision}e}'.split('e')
+    man, exps = f"{value:.{precision}e}".split("e")
     exp = int(exps)
-    return fr'{man}\times 10^{{{exp}}}'
+    return rf"{man}\times 10^{{{exp}}}"
 
 
-def saveplot(fig: Figure, *name_args: Any, close: bool = True,
-             **name_kwargs: Any) -> None:
+def saveplot(
+    fig: Figure, *name_args: Any, close: bool = True, **name_kwargs: Any
+) -> None:
     """Save matplotlib figure.
 
     You need to provide :data:`stem` as a positional or keyword argument (see
@@ -66,8 +68,9 @@ def saveplot(fig: Figure, *name_args: Any, close: bool = True,
         name_kwargs: keyword arguments passed on to :func:`out_name`.
     """
     oname = out_name(*name_args, **name_kwargs)
-    fig.savefig(f'{oname}.{conf.plot.format}',
-                format=conf.plot.format, bbox_inches='tight')
+    fig.savefig(
+        f"{oname}.{conf.plot.format}", format=conf.plot.format, bbox_inches="tight"
+    )
     if close:
         plt.close(fig)
 
@@ -85,9 +88,9 @@ def baredoc(obj: object) -> str:
     """
     doc = getdoc(obj)
     if not doc:
-        return ''
+        return ""
     doc = doc.splitlines()[0]
-    return doc.rstrip(' .').lstrip()
+    return doc.rstrip(" .").lstrip()
 
 
 def find_in_sorted_arr(value: Any, array: ndarray, after: bool = False) -> int: