Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Factor out bluesky-tiled-plugins package #814

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

danielballan
Copy link
Member

@danielballan danielballan commented Jun 20, 2024

This creates a second Python package in the databroker repository, bluesky-tiled-plugins, with the "special client" objects BlueskyRun, BlueskyEventStream, and CatalogOfBlueskyRuns, as well as the custom query objects PartialUID, ScanID, and TimeRange. Quoting the README:

For a user wishing to connect to a running Tiled server and access Bluesky data,
this package, along with its dependency tiled[client], is all they need.

The databroker package is only required if the user wants to use the legacy
databroker.Broker API.

This means it is no longer necessary to install databroker in the client environment unless they have legacy databroker.Broker code.

To be clear, the server environment still needs databroker.mongo_normalized, the Tiled Adapter for MongoDB with Bluesky document collections.


This is a backward-compatible change. Databroker now has a dependency on bluesky-tiled-plugins and has shim modules that expose the moved objects at the original locations within the databroker package.

Closes #812

@danielballan
Copy link
Member Author

I have registered the publish-pypi.yml workflow in this repository as a "pending" trusted publisher such that merge this PR should create the bluesky-tiled-plugins package on PyPI.

@@ -0,0 +1,3 @@
from ._catalog_of_bluesky_runs import CatalogOfBlueskyRuns # noqa: F401
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this work with entrypoints? I vaguely recall that entrypoints have to point to the actual definition, not an import.

@@ -0,0 +1,17 @@
# file generated by setuptools_scm
# don't change, don't track in version control
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This means you, @danielballan.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor Tiled plugins into separate package
1 participant