osprey-connectors API#
The Python API of osprey-connectors, the package that carries OSPREY’s
control-system and archiver connectors and installs without the rest of the
framework (pip install osprey-connectors). How to choose and configure a
connector is in Use Connectors; what every
connector must do is in Connector Contracts.
Every public module lists its public names in __all__, and these pages show
exactly those names. A module whose name starts with an underscore is internal
and can change in any release; the concrete connectors are among them, and a
caller builds one through ConnectorFactory
from its registered type name. Seven subpackages –
osprey_connectors.control_system, osprey_connectors.archiver,
osprey_connectors.ipc and the four service kinds on Directory, alarms and put log –
gather their implementation behind one namespace, and their names are imported
from the subpackage itself.
How the package versions, and what each release promises to keep compatible, is in the Stability section of the package’s README. These pages are built from the same tree as the rest of this site, so they can describe a connectors release newer or older than the one you have installed; the package’s changelog says which release added what.