0.1.0a7

.github/workflows/documentation.yaml

@@ -11,22 +11,37 @@ on:
       - 'bpod_core/**'
 
 permissions:
-  contents: write
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
 
 jobs:
-  docs:
+  build:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: astral-sh/setup-uv@v6
+      - uses: astral-sh/setup-uv@v7
+        with:
+          python-version: 3.13
       - uses: ts-graphviz/setup-graphviz@v2
       - name: sync dependencies
         run: uv sync --no-default-groups --group doc
       - name: build documentation
         run: uv run sphinx-build docs/source docs/build
-      - uses: peaceiris/actions-gh-pages@v4
+      - uses: actions/upload-pages-artifact@v3
         with:
-          publish_branch: gh-pages
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docs/build/
-          force_orphan: true
+          path: docs/build/
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/publish.yaml

@@ -3,7 +3,7 @@ on:
   workflow_dispatch:
   push:
     tags:
-      - '[0-9]+.[0-9]+.[0-9][abrc]?[0-9]*'  # Matches semantic version tags
+      - '[0-9]+\\.[0-9]+\\.[0-9](?:(?:a|b|rc)[0-9]+)?'  # Matches semantic version tags
 
 jobs:
   build:

.gitignore

@@ -193,6 +193,9 @@ target/
 profile_default/
 ipython_config.py
 
+# LLM files
+.repotomdrc
+
 # pyenv
 #   For a library or package, you might want to ignore these files since the code is
 #   intended to run in multiple environments; otherwise, check them in:

CHANGELOG.md

@@ -6,6 +6,23 @@ 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.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.1.0a7]
+
+### Added
+- `com.find_ports` for finding serial ports that match given filter criteria.
+- `com.verify_serial_discovery` for checking if a serial device sends an expected
+  discovery message.
+- convenience functions for reading and writing integers in `com.ExtendedSerial`.
+- `misc.extend_packed` for extending a bytearray by multiple values of the same format.
+- `misc.DocstringInheritanceMixin` for inheriting docstrings from base classes.
+- more examples.
+
+### Changed
+- more verbose debug logging during state machine runs.
+- replace unmaintained `appdirs` dependency with `platformdirs`.
+- switch to zero-based indexing for global counters, timers, conditions and soft-codes.
+- added file locking to `misc.SettingsDict`.
+
 ## [0.1.0a6] - 2025-10-29
 
 ### Added
@@ -19,6 +36,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `com.to_bytes`
 - dependency on Pandas
 
+
 ## [0.1.0a5] - 2025-09-03
 
 ### Added
@@ -87,6 +105,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 First alpha release. Nothing works.
 
+[0.1.0a7]: https://github.com/int-brain-lab/bpod-core/releases/tag/0.1.0a7
+[0.1.0a6]: https://github.com/int-brain-lab/bpod-core/releases/tag/0.1.0a6
 [0.1.0a5]: https://github.com/int-brain-lab/bpod-core/releases/tag/0.1.0a5
 [0.1.0a4]: https://github.com/int-brain-lab/bpod-core/releases/tag/0.1.0a4
 [0.1.0a3]: https://github.com/int-brain-lab/bpod-core/releases/tag/0.1.0-alpha.3

README.md

@@ -6,6 +6,9 @@
 
 A Python library for communicating with the [*Bpod Finite State Machine*](https://sanworks.io/).
 
+> [!WARNING]
+> bpod-core is under development and not yet ready for production use.
+
 This project is maintained by the software development team at the
 [*International Brain Lab*](https://internationalbrainlab.org/).