Deprecated databroker, and split bluesky-tiled-plugins into separate repo

.gitattributes

@@ -1,2 +1,4 @@
 databroker/_version.py export-subst
 .git_archival.txt  export-subst
+# SCM syntax highlighting & preventing 3-way merges
+pixi.lock merge=binary linguist-language=YAML linguist-generated=true

.github/workflows/docs.yml

@@ -0,0 +1,81 @@
+name: Documentation
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - main
+  release:
+    types:
+      - published
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  # Many color libraries just need this to be set to any value, but at least
+  # one distinguishes color depth, where "3" -> "256-bit color".
+  FORCE_COLOR: 3
+
+jobs:
+  docs-build:
+    name: Documentation build
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - uses: astral-sh/setup-uv@v7
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install
+        shell: bash -l {0}
+        run: source continuous_integration/scripts/install.sh
+
+      - name: Install docs requirements
+        shell: bash -l {0}
+        run: |
+          set -vxeuo pipefail
+          python -m pip install -r requirements-docs.txt
+          python -m pip list
+
+      - name: Build HTML
+        run: sphinx-build docs/source docs/_build/html
+
+      - name: Upload HTML as GitHub artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_build/html
+
+  docs-publish:
+    name: Deploy documentation to GitHub Pages
+    runs-on: ubuntu-latest
+    needs: docs-build
+    if: ${{ github.ref_name == 'main' }}
+
+    # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - name: Setup GitHub Pages
+        uses: actions/configure-pages@v5
+
+      - name: Deploy HTML to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/publish-pypi.yml

@@ -1,4 +1,4 @@
-name: CD
+name: Publish to PyPI
 
 on:
   workflow_dispatch:
@@ -41,32 +41,3 @@ jobs:
 
       - name: Cleanup dist folder
         run: rm -rf dist
-
-  dist-plugins:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      - uses: hynek/build-and-inspect-python-package@v2
-        with:
-          path: bluesky-tiled-plugins/
-          upload-name-suffix: "-bluesky-tiled-plugins"
-
-  publish-plugins:
-    needs: [dist-plugins]
-    environment: pypi
-    permissions:
-      id-token: write
-    runs-on: ubuntu-latest
-    if: github.event_name == 'release' && github.event.action == 'published'
-
-    steps:
-
-      - uses: actions/download-artifact@v4
-        with:
-          name: Packages-bluesky-tiled-plugins
-          path: dist
-
-      - uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/testing.yml

@@ -16,7 +16,7 @@ jobs:
         - 27017:27017
     strategy:
       matrix:
-        python-version: ["3.9", "3.10", "3.11", "3.12"]
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
       fail-fast: false
     steps:
 

.gitignore

@@ -141,3 +141,6 @@ data/*
 
 # version file generated by setuptools
 *_version.py
+# pixi environments
+.pixi/*
+!.pixi/config.toml

README.rst

@@ -4,9 +4,24 @@ Databroker
 
 |build_status| |coverage| |pypi_version| |license|
 
-**The Databroker project is now in maintenance mode, and it is not recommended
-for new users. It will be maintained until for years to come to support
-existing user code. New users should use Bluesky Tiled Plugins.**
+Deprecation Notice
+==================
+
+Databroker is no longer recommended for new users or facilities adopting
+Bluesky. Instead, `Tiled`_ with `Bluesky Tiled Plugins`_ is recommended as the
+canonical way to persist and access data and metadata from Bluesky.
+
+Databroker now serves two purposes that remain relevant for some users and some
+faciilities. First, it contains code adapting the legacy MongoDB-based Bluesky
+document storage to Tiled---effectively a server-side plugin for Tiled. Second,
+it wraps the Tiled Python client to provide an API backward-compatible with
+legacy Databroker user code. _If you do not have MongoDB-based Bluesky storage
+and you do not have legacy Databroker user code, you do not need Databroker._
+
+Databroker will be maintained by NSLS-II through **April 2027** at minimum to
+support the transition from MongoDB-based document storage to PostgreSQL-based
+storage. The Python user interface may be maintained longer still, depending on
+the need.
 
 ============== ==============================================================
 PyPI           ``pip install databroker``
@@ -93,3 +108,7 @@ See the tutorials for more.
 .. _Suitcase: https://blueskyproject.io/suitcase/
 
 .. _Intake: https://intake.readthedocs.io/en/latest/
+
+.. _Bluesky Tiled Plugins: https://blueskyproject.io/bluesky-tiled-plugins/
+
+.. _Tiled: https://blueskyproject.io/tiled/