Merge branch 'main' into feature/gh-actions-pylint-mypy

Author: grothe6

.github/workflows/test.yml

@@ -18,6 +18,10 @@ jobs:
     steps:
       - uses: tlambert03/setup-qt-libs@v1
       - uses: actions/checkout@v3
+        with:
+          # Fetch all history to get correct version numbers with versioningit
+          # Otherwise, `git describe` is not working
+          fetch-depth: 0
       - name: Set up Python ${{ matrix.python-version }}
         uses: actions/setup-python@v4
         with:

.gitignore

@@ -3,6 +3,7 @@ __pycache__/
 *.egg-info/
 
 dist/
+build/
 
 # generated images / documents
 *.png

.pre-commit-config.yaml

@@ -2,7 +2,7 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
     -   id: check-docstring-first
     -   id: check-yaml
@@ -15,7 +15,7 @@ repos:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v3.10.1
+    rev: v3.15.0
     hooks:
     -   id: pyupgrade
         args: [--py39-plus]
@@ -25,7 +25,7 @@ repos:
       - id: isort
         args: ["--profile", "black"]
 -   repo: https://github.com/psf/black
-    rev: 23.7.0
+    rev: 23.9.1
     hooks:
     -   id: black
         args: ["--line-length", "120"]

README.md

@@ -72,6 +72,12 @@ python -m pre-commit install
 
 To build the documentation, run:
 
+```
+tox -e docs
+```
+
+or
+
 ```
 cd docs
 make html

docs/conf.py

@@ -13,7 +13,9 @@
 # import os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
+from packaging.version import parse
 
+import qumada
 
 # -- Project information -----------------------------------------------------
 
@@ -22,7 +24,8 @@
 author = "JARA Institute for Quantum Information"
 
 # The full version, including alpha/beta/rc tags
-release = "0.3.2"
+release = parse(qumada.__version__).public
+version = qumada.__version__
 
 
 # -- General configuration ---------------------------------------------------

docs/installation.rst

@@ -63,6 +63,12 @@ Build documentation
 
 Run
 
+.. code-block:: console
+
+    tox -e docs
+
+or
+
 .. code-block:: console
 
     cd docs

pyproject.toml

@@ -1,6 +1,5 @@
 [project]
 name = "QuMADA"
-version = "0.4.1"
 description = "Measurement Abstraction and Database Access layer for QCoDeS"
 readme = "README.md"
 authors = [
@@ -15,15 +14,17 @@ classifiers = [
     "Topic :: Scientific/Engineering",
     "Intended Audience :: Science/Research",
 ]
+dynamic = ["version"]
 
 requires-python = ">=3.9"
 dependencies = [
-    "qcodes >= 0.37.0",
+    "qcodes >= 0.37.0, < 0.40.0",
     "qcodes_contrib_drivers >= 0.18.0",
     "matplotlib",
     "jsonschema",
     "zhinst-toolkit >= 0.3.3",
     "pyqt5",
+    "versioningit ~= 2.2.0",
 ]
 
 [project.optional-dependencies]
@@ -35,12 +36,39 @@ Repository = "https://github.com/qutech/qumada"
 Documentation = "https://qumada.readthedocs.io/en/latest/"
 
 [build-system]
-requires = ["setuptools"]
+requires = [
+    "setuptools >= 68.1.0",
+    "versioningit ~= 2.2.0",
+]
 build-backend = "setuptools.build_meta"
 
+[tool.setuptools.package-data]
+qumada = ["*.json"]
+
+[tool.versioningit]
+default-version = "0.0"
+
+[tool.versioningit.onbuild]
+source-file = "src/qumada/_version.py"
+build-file = "qumada/_version.py"
+
 [tool.pytest.ini_options]
+addopts = [
+    "--import-mode=importlib",
+]
 qt_api = "pyqt5"
 
+[tool.coverage.run]
+source = [
+    "qumada",
+]
+
+[tool.coverage.paths]
+source = [
+    "src",
+    "*/site-packages"
+]
+
 [tool.black]
 line-length = 120
 target-version = ['py39', 'py310', 'py311']

setup.cfg

@@ -1,8 +1,3 @@
-[options]
-package_dir =
-    = src
-packages = find:
-
 [flake8]
 max-line-length = 120
 extend-ignore = E203
@@ -11,8 +6,3 @@ extend-ignore = E203
 show_error_codes = True
 warn_unused_ignores = True
 ignore_missing_imports = True
-
-[coverage:run]
-omit =
-    */__init__.py
-    src/tests/*

setup.py

@@ -3,5 +3,6 @@
 """Setup.py"""
 
 from setuptools import setup
+from versioningit import get_cmdclasses
 
-setup()
+setup(cmdclass=get_cmdclasses())

src/qumada/__init__.py

@@ -14,3 +14,7 @@
 # You should have received a copy of the GNU General Public License along with
 # QuMADA. If not, see <https://www.gnu.org/licenses/>.
 #
+
+import qumada._version
+
+__version__ = qumada._version.__version__

src/tests/__init__.py src/qumada/_version.py

@@ -14,3 +14,27 @@
 # You should have received a copy of the GNU General Public License along with
 # QuMADA. If not, see <https://www.gnu.org/licenses/>.
 #
+# Contributors:
+# - Daniel Grothe
+
+# The idea is to get the current version from versioningit for editable installed qumada.
+# For built packages, versioningit's onbuild functionality replaces __version__'s value
+# with a fixed string.
+#
+# See
+# - https://github.com/QCoDeS/Qcodes/blob/master/qcodes/_version.py
+# - https://github.com/jwodder/versioningit/issues/8
+
+
+def get_version() -> str:
+    from pathlib import Path
+
+    import versioningit
+
+    import qumada
+
+    qumada_path = Path(qumada.__file__).parent
+    return versioningit.get_version(project_dir=qumada_path.parent.parent)
+
+
+__version__ = get_version()

tox.ini

@@ -3,16 +3,34 @@ envlist =
     py{39,310,311}
     flake8
     mypy
+    report
+    docs
+
+[tool:pytest]
+testpaths = src/tests
+addopts =
+    --cov-report=term
 
 [testenv:py{39,310,311}]
+setenv =
+    COVERAGE_FILE = .coverage.{envname}
 deps =
     pytest
     pytest-cov
     pytest-cases
     pytest-mock
     pytest-qt
 commands =
-     pytest --cov=src/qumada --cov-report term src/tests {posargs}
+     pytest --cov {posargs}
+depends =
+    report: py{39,310,311}
+
+[testenv:report]
+skip_install = true
+deps = coverage
+commands =
+    coverage combine
+    coverage report
 
 [testenv:flake8]
 deps =
@@ -25,3 +43,9 @@ deps =
     mypy
 commands =
     mypy src {posargs}
+
+[testenv:docs]
+deps =
+    -rdocs{/}requirements.txt
+commands =
+    sphinx-build docs docs{/}_build -bhtml {posargs}