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