Merge pull request #7 from TaskBeacon/codex/standardize-version-management

Read version from pyproject

Author: zh1peng

docs/conf.py

@@ -9,7 +9,11 @@
 project = 'psyflow'
 copyright = '2025, Zhipeng Cao'
 author = 'Zhipeng Cao'
-release = '0.1.0'
+import os
+import sys
+sys.path.insert(0, os.path.abspath(".."))  # so Sphinx can find your package
+from psyflow._version import read_version
+release = read_version()
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -27,11 +31,6 @@
 html_theme = 'alabaster'
 html_static_path = ['_static']
 
-
-import os
-import sys
-sys.path.insert(0, os.path.abspath(".."))  # so Sphinx can find your package
-
 # Enable extensions
 extensions = [
     "myst_parser",                      # Markdown support

docs/index.rst

@@ -35,6 +35,12 @@ Start with one of the tutorials below or explore the API reference.
 
    modules
 
+.. toctree::
+   :maxdepth: 1
+   :caption: Development
+
+   release
+
 
 Indices and tables
 ==================

docs/release.md

@@ -0,0 +1,5 @@
+# Release workflow
+
+1. Update the version number in `pyproject.toml` under the `[project]` section.
+2. Commit the change with a message that includes `[publish]` to trigger the release pipeline.
+3. Build and upload the package as usual.

psyflow/__init__.py

@@ -1,7 +1,6 @@
-"""
-psyflow: A utility package for modular PsychoPy experiment development
-"""
-__version__ = "0.1.0"
+"""psyflow: A utility package for modular PsychoPy experiment development."""
+
+from ._version import __version__
 from .BlockUnit import BlockUnit
 from .StimBank import StimBank
 from .SubInfo import SubInfo

psyflow/_version.py

@@ -0,0 +1,17 @@
+from __future__ import annotations
+from pathlib import Path
+import re
+
+
+def read_version() -> str:
+    """Return project version from pyproject.toml."""
+    root = Path(__file__).resolve().parent.parent
+    pyproject = root / "pyproject.toml"
+    text = pyproject.read_text()
+    match = re.search(r'^version\s*=\s*"([^"]+)"', text, re.MULTILINE)
+    if not match:
+        raise RuntimeError("Version not found in pyproject.toml")
+    return match.group(1)
+
+
+__version__ = read_version()

setup.py

@@ -1,8 +1,18 @@
+from pathlib import Path
+import re
 from setuptools import setup, find_packages
 
+
+def read_version() -> str:
+    text = Path(__file__).with_name("pyproject.toml").read_text()
+    match = re.search(r'^version\s*=\s*"([^"]+)"', text, re.MULTILINE)
+    if not match:
+        raise RuntimeError("Version not found in pyproject.toml")
+    return match.group(1)
+
 setup(
     name="psyflow",
-    version="0.1.0",
+    version=read_version(),
     description="A utility package for building modular PsychoPy experiments.",
     author="Zhipeng Cao",
     author_email="[email protected]",