Release 2.0.0

.github/workflows/docs.yml

@@ -0,0 +1,53 @@
+name: Deploy Documentation
+
+on:
+  push:
+    tags:
+      - '*'
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[dev]
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+
+      - name: Build documentation
+        run: properdocs build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v4
+        with:
+          path: ./site
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/pypi_publish.yml

@@ -0,0 +1,53 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Build distribution packages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0  # Full history needed for setuptools_scm
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.x"
+
+      - name: Install build dependencies
+        run: python -m pip install --upgrade pip build
+
+      - name: Build distribution packages
+        run: python -m build
+
+      - name: Store the distribution packages
+        uses: actions/upload-artifact@v7
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # Only publish for tagged releases
+    needs:
+      - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/odin-control
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v8
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/test_odin_control.yml

@@ -9,12 +9,14 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12']
+        python-version: ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13', '3.14']
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
+      with:
+        fetch-depth: 0
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
@@ -26,31 +28,11 @@ jobs:
     - name: Merge tox env specific coverage files
       run: |
         coverage combine
-        if [[ "${{ matrix.python-version }}" == 2.7* ]]; then
-            export COVERAGE_RC=.coveragerc-py27
-        else
-            export COVERAGE_RC=.coveragerc
-        fi
-        coverage xml --rcfile=$COVERAGE_RC
+        coverage xml
     - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v4
+      uses: codecov/codecov-action@v5
       env:
         CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
       with:
         name: ${{ matrix.python-version }}
         fail_ci_if_error: false
-
-  notify:
-    if: ${{ always() }}
-    runs-on: ubuntu-latest
-    needs: build_and_test
-    steps:
-      - name: Slack Notification on completion
-        uses: rtCamp/action-slack-notify@v2
-        env:
-          SLACK_CHANNEL: odin-control-notify
-          SLACK_COLOR: ${{ needs.build_and_test.result }}
-          SLACK_ICON: https://avatars.githubusercontent.com/odin-detector?size=48
-          SLACK_TITLE: "odin-control CI tests completed: ${{ needs.build_and_test.result }}"
-          SLACK_USERNAME: odin-detector
-          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}

.gitignore

@@ -23,7 +23,7 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
-src/odin/_version.py
+src/odin_control/_version.py
 
 # PyInstaller
 #  Usually these files are written by a python script from a template
@@ -103,3 +103,6 @@ tags
 
 # Visual studio code metadata
 .vscode/
+
+# Ignore mkdocs site generation output
+site/

README.md

@@ -1,4 +1,17 @@
 # odin-control
 
 [![Test odin-control](https://github.com/odin-detector/odin-control/actions/workflows/test_odin_control.yml/badge.svg)](https://github.com/odin-detector/odin-control/actions/workflows/test_odin_control.yml)
-[![codecov](https://codecov.io/gh/odin-detector/odin-control/branch/master/graph/badge.svg?token=Urucx8wsTU)](https://codecov.io/gh/odin-detector/odin-control)
+[![codecov](https://codecov.io/gh/odin-detector/odin-control/branch/main/graph/badge.svg?token=Urucx8wsTU)](https://codecov.io/gh/odin-detector/odin-control)
+[![PyPI](https://img.shields.io/pypi/v/odin-control.svg)](https://pypi.org/project/odin-control)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+
+Source          | <https://github.com/odin-detector/odin-control>
+:---:           | :---:
+PyPI            | `pip install odin-control`
+Documentation   | <https://odin-detector.github.io/odin-control/>
+Releases        | <https://github.com/odin-detector/odin-control/releases>
+
+odin-control is a Python web application framework designed to support integration of the control
+plane of scientific detector systems. Based on the [Tornado](https://tornadoweb.org) framework,
+odin-control provides a REST-like API interface to a set of dynamically-loaded plugins, known as
+*adapters*, which control the underlying detector system.