Update MANIFEST.in to include additional file types and LICENSE; modify pyproject.toml for package data and publishing settings; refactor version retrieval in flika/version.py to use importlib.metadata.

Author: kyleellefsen

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

@@ -7,6 +7,9 @@ jobs:
   publish: 
     name: publish
     runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/flika
     permissions:
       id-token: write
     steps:
@@ -21,4 +24,4 @@ jobs:
           python -m pip install -U pip build
           python -m build
       - name : Publish Flika to PyPI
-        uses: pypa/gh-action-pypi-publish@v1.8.11
+        uses: pypa/gh-action-pypi-publish@v1.12.4

MANIFEST.in

@@ -1,4 +1,7 @@
-recursive-include flika *.ui *.png *.ico
+recursive-include flika *.ui *.png *.ico *.tif *.txt *.py
 include README.md
+include LICENSE
+include pyproject.toml
+include py.typed
 include flika.desktop
 recursive-include examples *.py

flika/version.py

@@ -1,46 +1,7 @@
 """
-Module providing the flika version, extracted from pyproject.toml.
+Module providing the flika version, extracted from package metadata.
 """
 
-import tomllib
-from pathlib import Path
+import importlib.metadata
 
-
-def _get_version() -> str:
-    """
-    Parse pyproject.toml to extract the flika version.
-
-    Returns:
-        str: The version string of flika.
-    """
-    # Find the pyproject.toml file relative to this file (version.py)
-    module_path = Path(__file__).resolve()
-    pyproject_path = None
-
-    # Look in the parent directories of this file for pyproject.toml
-    for path in [module_path.parent, *module_path.parent.parents]:
-        potential_path = path / "pyproject.toml"
-        if potential_path.exists():
-            pyproject_path = potential_path
-            break
-
-    if pyproject_path is None:
-        raise FileNotFoundError(
-            "Could not find pyproject.toml in parent directories of the module"
-        )
-
-    # Parse the TOML file
-    with open(pyproject_path, "rb") as f:
-        pyproject_data = tomllib.load(f)
-
-    # Extract the version
-    flika_version = pyproject_data.get("project", {}).get("version")
-
-    if flika_version is None:
-        raise ValueError("Version not found in pyproject.toml")
-
-    return flika_version
-
-
-# Expose the version at module level
-__version__ = _get_version()
+__version__ = importlib.metadata.version("flika")

pyproject.toml

@@ -71,23 +71,21 @@ dev = [
     "sphinxcontrib-napoleon>=0.7",
     "mypy",
     "scipy-stubs",
-
 ]
 
 [tool.setuptools]
 packages = ["flika"]
+package-dir = {"" = "."}
 
 [tool.setuptools.package-data]
-"gui" = ["*.ui"]
-"images" = ["*.ico", "*.png", "*.txt", "*.tif"]
+"flika" = ["*.ui", "*.ico", "*.png", "*.txt", "*.tif"]
 
 [tool.pytest.ini_options]
 testpaths = ["flika"]
 python_files = "test_*.py"
 python_classes = "Test*"
 python_functions = "test_*"
 
-
 [tool.ruff]
 line-length = 88