Skip to main content

CI Coverage PyPI License

blueapi

Lightweight bluesky-as-a-service wrapper application. Also usable as a library.

What Where
Source https://github.com/DiamondLightSource/blueapi
PyPI pip install blueapi
Docker docker run ghcr.io/diamondlightsource/blueapi:latest
Documentation https://diamondlightsource.github.io/blueapi
Releases https://github.com/DiamondLightSource/blueapi/releases

This module wraps bluesky plans and devices inside a server and exposes endpoints to send commands/receive data. Useful for installation at labs where multiple people may control equipment, possibly from remote locations.

The main premise of blueapi is to minimize the boilerplate required to get plans and devices up and running by generating an API for your lab out of type-annotated plans. For example, take the following plan:

import bluesky.plans as bp
from blueapi.core import MsgGenerator

def my_plan(foo: str, bar: int) -> MsgGenerator:
    yield from bp.scan(...)

Blueapi's job is to detect this plan and automatically add it to the lab's API so it can be invoked easily with a few REST calls.

See https://diamondlightsource.github.io/blueapi for more detailed documentation.

Metadata

Release files for blueapi 1.22.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for blueapi 1.22.0
File Size Uploaded Provenance Actions
blueapi-1.22.0.tar.gz 2.9 MB Without provenance Details for blueapi-1.22.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for blueapi 1.22.0
File Interpreter ABI Platform Actions
blueapi-1.22.0-py3-none-any.whl Python 3 none any Details for blueapi-1.22.0-py3-none-any.whl

Total release size: 3.0 MB

Release files / blueapi-1.22.0.tar.gz

Download URL blueapi-1.22.0.tar.gz
Size 2.9 MB
Tags Source
SHA-256 checksum
How to use checksums
b099cd20c7053482169ae08675eb77e9c8e0650bd366def580792cb59f1cb8a6
BLAKE2b-256 checksum
How to use checksums
34b0b2416e338593c2f1dcad064af349be92f183497b4cae70a4e954c06426f8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Release files / blueapi-1.22.0-py3-none-any.whl

Download URL blueapi-1.22.0-py3-none-any.whl
Size 98.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0ca6050e7162a0e1d920c75055cd3891723f97d470a4cc7f260c011dfd445114
BLAKE2b-256 checksum
How to use checksums
2440e8b90c72bfc1500ced75ff4cff02c23d0ce5cb6ce7f6c9653e17e478451b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Security for blueapi 1.22.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.22.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page