v0.2.0 (#68)

- Added an automated CI/CD pipeline to publish releases to PyPI.
- Enabled dynamic package versioning and updated build configuration and packaging requirements (uses setuptools-scm).
- Added RELEASE.md (release guide documenting versioning conventions and release steps).
- Updated the CHANGELOG.

Author: vinamarora8

.github/workflows/publish.yml

@@ -0,0 +1,90 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  validate-tag:
+    name: Validate tag follows RELEASE.md
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Validate tag format
+        run: |
+          TAG="${{ github.ref_name }}"
+          
+          python << EOF
+          import re
+          
+          tag = '$TAG'
+          
+          # Check for valid patterns: vX.Y.Z, vX.Y.ZrcN, vX.Y.ZaN, vX.Y.ZbN
+          # With optional .postN suffix: vX.Y.Z.postN, vX.Y.ZrcN.postN, etc.
+          # Where X, Y, Z, N are numbers
+          pattern = r'^v\d+\.\d+\.\d+(rc\d+|a\d+|b\d+)?(\.post\d+)?$'
+          
+          if not re.match(pattern, tag):
+              print(f'✗ Tag {tag} does not match required format (per RELEASE.md)')
+              print('  Valid formats: vX.Y.Z, vX.Y.ZrcN, vX.Y.ZaN, vX.Y.ZbN')
+              print('  With optional .postN: vX.Y.Z.postN, vX.Y.ZrcN.postN, etc.')
+              print('  Where X, Y, Z, N are numbers')
+              exit(1)
+          
+          print(f'✓ Tag {tag} is valid')
+          EOF
+
+  build:
+    name: Build distribution 📦
+    needs: validate-tag
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0 # IMPORTANT: Required for setuptools-scm to see tags!
+        persist-credentials: false
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.10"
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v4
+      with:
+        enable-cache: true
+
+    - name: Build a binary wheel and a source tarball
+      run: uv build
+
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: Publish Python 🐍 distribution 📦 to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/brainsets
+    permissions:
+      id-token: write # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

CHANGELOG.md

@@ -3,6 +3,26 @@
 All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+### Added
+
+### Removed
+
+### Changed
+
+## [0.2.0] - 2025-12-24
+### Added
+- New brainset pipeline: `allen_visual_coding_ophys_2016` ([#16](https://github.com/neuro-galaxy/brainsets/pull/16)).
+- Added `STEREO_EEG` to `RecordingTech` enum ([#36](https://github.com/neuro-galaxy/brainsets/pull/36)).
+- Added `BrainsetPipeline` definition with a `brainset.runner` module to run `BrainsetPipeline` in parallel ([#37](https://github.com/neuro-galaxy/brainsets/pull/37)).
+- Added support for PEP723-style inline metadata blocks to specify Python version and dependencies in a `pipeline.py` file ([#62](https://github.com/neuro-galaxy/brainsets/pull/62)).
+- New brainset pipeline: `kemp_sleep_edf_2013` ([#54](https://github.com/neuro-galaxy/brainsets/pull/54)).
+
+### Changed
+- Fixed issue with "test" session being overwritten in the `perich_miller_population_2018` pipeline ([#25](https://github.com/neuro-galaxy/brainsets/pull/25)).
+- Updated all existing pipelines with `BrainsetPipeline` and dependencies in metadata block ([#37](https://github.com/neuro-galaxy/brainsets/pull/37) and [#62](https://github.com/neuro-galaxy/brainsets/pull/62)).
+
+
 ## [0.1.3] - 2025-10-27
 ### Added
 - Added support for python 3.12 and 3.13 ([#14](https://github.com/neuro-galaxy/brainsets/pull/30)).

README.md

@@ -30,6 +30,8 @@ pip install brainsets
 | odoherty_sabes_nonhuman_2017 | [Link](https://brainsets.readthedocs.io/en/latest/glossary/brainsets.html#odoherty-sabes-nonhuman-2017) | 22 GB | 26 GB |
 | pei_pandarinath_nlb_2021  | [Link](https://brainsets.readthedocs.io/en/latest/glossary/brainsets.html#pei-pandarinath-nlb-2021) | 688 KB | 22 MB |
 | perich_miller_population_2018 | [Link](https://brainsets.readthedocs.io/en/latest/glossary/brainsets.html#perich-miller-population-2018) | 13 GB | 2.9 GB |
+| kemp_sleep_edf_2013 | TBA | 8.2 GB | 60 GB |
+| allen_visual_coding_ophys_2016 | TBA | 356 GB | 58 GB |
 
 
 ## Acknowledgements

RELEASE.md

@@ -0,0 +1,33 @@
+# Releasing to PyPI
+
+1. Ensure `main` is ready to release.
+2. Make sure `CHANGELOG.md` is up to date (review commit history to verify, open a Release PR if changes are needed).
+3. Verify the version in `CHANGELOG.md` matches the version you're about to tag.
+4. If a new brainset pipeline has been added, verify that it is mentioned in the project README.
+5. Create and push the release tag ([see here](#valid-version-numbers-and-their-meaning) for version syntax).
+
+```bash
+$ git checkout main
+$ git pull origin main
+$ git tag vX.Y.Z
+$ git push origin vX.Y.Z
+```
+
+6. Monitor the GitHub Actions workflow to ensure the build and publish succeed.
+7. Add a GitHub Release with a small description of changes from the last release.
+
+**Note:** Tags must start with "v" for the publishing GitHub Action to begin.
+
+## Valid version numbers and their meaning
+
+- For version number, we follow [SemVer](https://semver.org/) (major.minor.patch).
+- For pre-release tags, we follow the [PEP440](https://peps.python.org/pep-0440/) syntax:
+```
+vX.Y.ZaN   # Alpha release
+vX.Y.ZbN   # Beta release
+vX.Y.ZrcN  # Release candidate
+vX.Y.Z     # Final release
+```
+- For post-release tags, we also follow the [PEP440](https://peps.python.org/pep-0440/) syntax:
+  - `vY.Y.Z.postN`, `vX.Y.Z.aN.postM`, ...
+  - Post releases are only meant for metadata/distribution related corrections, and not code edits

brainsets/__init__.py

@@ -1,3 +1,9 @@
-__version__ = "0.1.0"
+from importlib.metadata import version, PackageNotFoundError
 
 from .core import serialize_fn_map
+
+try:
+    __version__ = version("brainsets")
+except PackageNotFoundError:  # pragma: no cover
+    # This can happen if someone is importing brainsets without installing
+    __version__ = "unknown"  # pragma: no cover

pyproject.toml

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["setuptools>=60.2.0"]
+requires = ["setuptools>=80", "setuptools-scm[simple]>=8"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "brainsets"
-version = "0.1.3"
+dynamic = ["version"]
 description = "A package for processing neural datasets"
 readme = "README.md"
 authors = [{ name = "Mehdi Azabou", email = "mehdiazabou@gmail.com" }]
@@ -32,7 +32,8 @@ dependencies = [
     "prompt_toolkit",
     "numpy>=1.14.0",
     "pulp<2.8",
-    "ray>=2.30.0",
+    "ray>=2.30.0,<2.52.0; python_version < \"3.10\"",  # ray 2.52.0+ dropped support for Py3.9
+    "ray>=2.30.0; python_version >= \"3.10\"",
     "tomli; python_version < \"3.11\"", # tomllib was not part of stddlib before 3.11
 ]
 

tests/test_version.py

@@ -0,0 +1,6 @@
+import brainsets
+
+
+def test_version_exists():
+    assert hasattr(brainsets, "__version__")
+    assert len(brainsets.__version__) > 0