update

Author: nathanael-perraudin-synth

.github/workflows/ci.yml

@@ -20,7 +20,7 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        python-version: [ "3.13"]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
     - uses: actions/checkout@v4

.gitignore

@@ -1,5 +1,6 @@
 uv.lock
 .venv/
+coverage.xml
 __pycache__/
 
 # Packages

doc/conf.py

@@ -1,65 +1,62 @@
-# -*- coding: utf-8 -*-
-
 import pyunlocbox
 
 extensions = [
-        'sphinx.ext.viewcode',
-        'sphinx.ext.autosummary',
-        'sphinx.ext.mathjax',
-        'sphinx.ext.inheritance_diagram',
+    "sphinx.ext.viewcode",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.inheritance_diagram",
 ]
 
-extensions.append('sphinx.ext.autodoc')
+extensions.append("sphinx.ext.autodoc")
 autodoc_default_options = {
-    'members': True,
-    'undoc-members': True,
-    'show-inheritance': True,
-    'member-order': 'bysource',  # alphabetical, groupwise, bysource
+    "members": True,
+    "undoc-members": True,
+    "show-inheritance": True,
+    "member-order": "bysource",  # alphabetical, groupwise, bysource
 }
 
-extensions.append('sphinx.ext.intersphinx')
+extensions.append("sphinx.ext.intersphinx")
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3', None),
-    'numpy': ('https://numpy.org/doc/stable', None),
-    'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
-    'matplotlib': ('https://matplotlib.org', None),
-    'pygsp': ('https://pygsp.readthedocs.io/en/stable', None),
+    "python": ("https://docs.python.org/3", None),
+    "numpy": ("https://numpy.org/doc/stable", None),
+    "scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
+    "matplotlib": ("https://matplotlib.org", None),
+    "pygsp": ("https://pygsp.readthedocs.io/en/stable", None),
 }
 
-extensions.append('numpydoc')
+extensions.append("numpydoc")
 numpydoc_show_class_members = False
 
-extensions.append('matplotlib.sphinxext.plot_directive')
+extensions.append("matplotlib.sphinxext.plot_directive")
 plot_include_source = True
 plot_html_show_source_link = False
 plot_html_show_formats = False
-plot_working_directory = '.'
+plot_working_directory = "."
 
-extensions.append('sphinx_copybutton')
+extensions.append("sphinx_copybutton")
 copybutton_prompt_text = ">>> "
 
-extensions.append('sphinxcontrib.bibtex')
-bibtex_bibfiles = ['references.bib']
+extensions.append("sphinxcontrib.bibtex")
+bibtex_bibfiles = ["references.bib"]
 
-exclude_patterns = ['_build']
-source_suffix = '.rst'
-master_doc = 'index'
+exclude_patterns = ["_build"]
+source_suffix = ".rst"
+master_doc = "index"
 
-project = 'PyUNLocBoX'
+project = "PyUNLocBoX"
 version = pyunlocbox.__version__
 release = pyunlocbox.__version__
-copyright = 'EPFL LTS2'
+copyright = "EPFL LTS2"
 
-pygments_style = 'sphinx'
-html_theme = 'sphinx_rtd_theme'
+pygments_style = "sphinx"
+html_theme = "sphinx_rtd_theme"
 html_theme_options = {
-    'navigation_depth': 2,
+    "navigation_depth": 2,
 }
 latex_elements = {
-    'papersize': 'a4paper',
-    'pointsize': '10pt',
+    "papersize": "a4paper",
+    "pointsize": "10pt",
 }
 latex_documents = [
-    ('index', 'pyunlocbox.tex', 'PyUNLocBoX documentation',
-     'EPFL LTS2', 'manual'),
+    ("index", "pyunlocbox.tex", "PyUNLocBoX documentation", "EPFL LTS2", "manual"),
 ]

pyunlocbox/__init__.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 r"""
 The package is mainly organized around two class hierarchies: the functions and
 the solvers. Instantiated functions represent convex functions to optimize.
@@ -17,18 +15,20 @@
 
 """
 
-from pyunlocbox import functions  # noqa: F401
-from pyunlocbox import solvers  # noqa: F401
 from pyunlocbox import acceleration  # noqa: F401
+from pyunlocbox import functions  # noqa: F401
 from pyunlocbox import operators  # noqa: F401
+from pyunlocbox import solvers  # noqa: F401
 
-__version__ = '0.5.2'
-__release_date__ = '2017-12-15'
+__version__ = "0.5.2"
+__release_date__ = "2017-12-15"
 
 
 def test():  # pragma: no cover
     """Run the test suite."""
     import unittest
+
     # Lazy as it might be slow and require additional dependencies.
     from pyunlocbox.tests import suite
+
     unittest.TextTestRunner(verbosity=2).run(suite)