Merge pull request #3 from gschramm/pyproject

Pyproject

.github/workflows/build_python_package.yml

@@ -0,0 +1,41 @@
+name: Build and Test Package
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout the repository
+      - name: Checkout code
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0 # Fetch all history to ensure tags are available
+
+      # Set up Python
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.12 # Change to the desired Python version
+
+      # Install dependencies
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+
+      # Build the package
+      - name: Build the package
+        run: |
+          python -m build
+
+      # Test importing the package
+      - name: Test the package import
+        run: |
+          python -m pip install dist/*.whl
+          python -c "import pymirc; print('pymirc version:', pymirc.__version__)"

.github/workflows/publish-to-pypi.yml

@@ -21,6 +21,8 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Fetch all history to ensure tags are available
       - name: Set up Python 3.12
         uses: actions/setup-python@v4
         with:

pymirc/__init__.py

@@ -3,10 +3,9 @@
 from . import metrics
 from . import viewer
 
-from pkg_resources import get_distribution, DistributionNotFound
+from importlib.metadata import version, PackageNotFoundError
 
 try:
-    __version__ = get_distribution(__name__).version
-except DistributionNotFound:
-    # package is not installed
-    pass
+    __version__ = version("pymirc")
+except PackageNotFoundError:
+    __version__ = "unknown"

pyproject.toml

@@ -0,0 +1,43 @@
+[build-system]
+requires = ["setuptools >= 61.0", "wheel", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = { find = { include = ["pymirc*"], exclude = ["tutorial*"] } }
+
+[tool.setuptools_scm]
+version_scheme = "post-release"
+local_scheme = "dirty-tag"
+
+[project]
+name = "pymirc"
+dynamic = ["version"]
+dependencies = [
+  "numpy>=1.15",
+  "scipy>=1.1",
+  "matplotlib>=2.2.2",
+  "pydicom>=2.0",
+  "scikit-image>=0.14",
+  "numba>=0.39",
+  "nibabel>=3.0",
+]
+requires-python = ">=3.8"
+authors = [
+  {name = "Georg Schramm"},
+  {name = "Tom Eelbode"},
+  {name = "Jeroen Bertels"},
+]
+maintainers = [
+  {name = "Georg Schramm", email = "[email protected]"}
+]
+description = "Python imaging utilities developed in the medical imaging research center of KU Leuven"
+readme = "README.md"
+license = {file = "LICENSE"}
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "License :: OSI Approved :: GNU Lesser General Public License v3 or later (LGPLv3+)",
+  "Operating System :: OS Independent",
+]
+
+[project.urls]
+Repository = "https://github.com/gschramm/pymirc"

style_guide.md

@@ -1,6 +1,5 @@
-Style guide for pymirc
-======================
+# Style guide for pymirc
 
-* no tabs in source code (use spaces)
-* use 2 or 4 spaces for indentation
-* use numpy style for docstrings  https://sphinxcontrib-napoleon.readthedocs.io/en/latest/
+- no tabs in source code (use spaces)
+- use numpy style for docstrings https://sphinxcontrib-napoleon.readthedocs.io/en/latest/
+- use black formatter