[103] Configure linting with ruff

.github/workflows/build-test.yml

@@ -18,6 +18,9 @@ jobs:
       - name: Test package
         run: hatch test
 
+      - name: Lint package
+        run: hatch fmt --check
+
       - name: Build package
         run: hatch build
 

doc/conf.py

@@ -1,7 +1,5 @@
-# coding=utf-8
 import ibei
 
-
 # Configuration file for the Sphinx documentation builder.
 #
 # This file only contains a selection of the most common options. For a full
@@ -21,9 +19,9 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'ibei'
-copyright = '2022, Joshua Ryan Smith'
-author = 'Joshua Ryan Smith'
+project = "ibei"
+copyright = "2022, Joshua Ryan Smith"
+author = "Joshua Ryan Smith"
 version = ibei.__version__
 
 
@@ -32,22 +30,17 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.mathjax',
-    'sphinx.ext.napoleon',
-    'sphinxcontrib.bibtex'
-]
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.mathjax", "sphinx.ext.napoleon", "sphinxcontrib.bibtex"]
 
 # Configuration for `autodoc`.
 autodoc_member_order = "bysource"
 
 
 # Configuration for `sphinxcontrib-bibtex`.
-bibtex_bibfiles = ['bib.bib']
+bibtex_bibfiles = ["bib.bib"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -60,10 +53,10 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]

pyproject.toml

@@ -77,3 +77,11 @@ source = "vcs"
 
 [tool.hatch.version.raw-options]
 local_scheme = "no-local-version"
+
+[tool.ruff]
+exclude = ["src/ibei/_version.py"]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["PLC0414"]
+"doc/conf.py" = ["INP001", "A001"]
+"test/test*" = ["S101", "INP001"]

src/ibei/__init__.py

@@ -1,5 +1,4 @@
-# coding=utf-8
-"""
+r"""
 Base Library (:mod:`ibei`)
 ==========================
 
@@ -27,7 +26,7 @@
 and given by
 
 .. math::
-    G_{m}(T, \mu) = \\frac{2 \pi}{h^{3} c^{2}} \int_{0}^{\infty} E^{m} \\frac{1}{\exp(\\frac{E-\mu}{kT}) - 1} dE
+    G_{m}(T, \mu) = \frac{2 \pi}{h^{3} c^{2}} \int_{0}^{\infty} E^{m} \frac{1}{\exp(\frac{E-\mu}{kT}) - 1} dE
 
 (a glossary of symbols is given at the end of the docstring). The full
 Bose-Einstein integral can be expressed as a sum of an
@@ -40,12 +39,12 @@
 where
 
 .. math::
-    G_{m} (E_{g}, T, \mu) = \\frac{2 \pi}{h^{3} c^{2}} \int_{E_{g}}^{\infty} E^{m} \\frac{1}{\exp(\\frac{E-\mu}{kT}) - 1} dE
+    G_{m} (E_{g}, T, \mu) = \frac{2 \pi}{h^{3} c^{2}} \int_{E_{g}}^{\infty} E^{m} \frac{1}{\exp(\frac{E-\mu}{kT}) - 1} dE
 
 and
 
 .. math::
-    g_{m} (E_{g}, T, \mu) = \\frac{2 \pi}{h^{3} c^{2}} \int_{0}^{E_{g}} E^{m} \\frac{1}{\exp(\\frac{E-\mu}{kT}) - 1} dE
+    g_{m} (E_{g}, T, \mu) = \frac{2 \pi}{h^{3} c^{2}} \int_{0}^{E_{g}} E^{m} \frac{1}{\exp(\frac{E-\mu}{kT}) - 1} dE
 
 This module provides functionality to compute each integral given
 above via the :class:`BEI` class.
@@ -62,9 +61,11 @@
     :math:`k`: Boltzmann's constant
 """
 
-from .models import BEI, SQSolarcell, DeVosSolarcell
+from ibei.models import BEI as BEI
+from ibei.models import DeVosSolarcell as DeVosSolarcell
+from ibei.models import SQSolarcell as SQSolarcell
 
 try:
-    from ._version import __version__
+    from ibei._version import __version__
 except ModuleNotFoundError:
     __version__ = ""