Merge pull request #873 from genematx/restructure

Restructure

Author: danielballan

bluesky-tiled-plugins/bluesky_tiled_plugins/__init__.py

@@ -1,7 +1,7 @@
-from .bluesky_event_stream import BlueskyEventStream  # noqa: F401
-from .bluesky_run import BlueskyRun  # noqa: F401
-from .catalog_of_bluesky_runs import CatalogOfBlueskyRuns  # noqa: F401
-from .tiled_writer import TiledWriter  # noqa: F401
+from .clients.bluesky_event_stream import BlueskyEventStream  # noqa: F401
+from .clients.bluesky_run import BlueskyRun  # noqa: F401
+from .clients.catalog_of_bluesky_runs import CatalogOfBlueskyRuns  # noqa: F401
+from .writing.tiled_writer import TiledWriter  # noqa: F401
 
 __all__ = [
     "BlueskyEventStream",

bluesky-tiled-plugins/bluesky_tiled_plugins/clients/__init__.py

@@ -10,8 +10,8 @@
 from tiled.queries import Comparison, Eq, Like
 from tiled.utils import safe_json_dump
 
+from ..queries import RawMongo, ScanIDRange, TimeRange, _PartialUID, _ScanID
 from .bluesky_run import BlueskyRunV2, BlueskyRunV3
-from .queries import RawMongo, ScanIDRange, TimeRange, _PartialUID, _ScanID
 
 
 class CatalogOfBlueskyRuns(Container):

bluesky-tiled-plugins/bluesky_tiled_plugins/_common.py renamed to bluesky-tiled-plugins/bluesky_tiled_plugins/clients/_common.py

@@ -4,14 +4,26 @@
 
 
 async def json_seq_exporter(mimetype, adapter, metadata, filter_for_access):
-    """
-    Export BlueskyRun is newline-delimited sequence of JSON.
+    """Export BlueskyRun as newline-delimited sequence of JSON documents.
+
+    This callback is to be configured on the server-side to enable exporting
+    BlueskyRun objects in JSON-Seq format.
+
+    The resulting stream yields strings, each of which is a JSON document
+    representing one of the standard Bluesky documents: start, descriptor,
+    event, stream_resource, stream_datum, and stop, in the appropriate order.
 
-    Format is like:
+    For example:
 
+    ```
     {"name": "start", "doc": {...}}
     {"name": "descriptor", "doc": {...}}
+    {"name": "event", "doc": {...}}
+    {"name": "stream_resource", "doc": {...}}
+    {"name": "stream_datum", "doc": {...}}
     ...
+    {"name": "stop", "doc": {...}}
+    ```
     """
     for spec in adapter.specs:
         if spec.name == "BlueskyRun" and spec.version.startswith("3."):

bluesky-tiled-plugins/bluesky_tiled_plugins/bluesky_event_stream.py renamed to bluesky-tiled-plugins/bluesky_tiled_plugins/clients/bluesky_event_stream.py

@@ -10,6 +10,7 @@
 That code has been extremely stable for about ten years, so divergence
 is not a pressing concern.
 """
+
 import sys
 import types
 from itertools import count