Skip to main content

A library and actor to communicate with an STA Archon controller.

Project description


Versions Code style: black Documentation Status Test Docker codecov

A library and actor to communicate with an STA Archon controller.


In general you should be able to install archon by doing

pip install sdss-archon

To build from source, use

git clone
cd archon
pip install .


The actor can run as a Docker container; new images for main (pointing to tag latest) and tags are created via a GitHub Action. The images are stored in the GitHub Container Registry. To pull the latest image run

docker pull

To run a container

docker run --name archon --rm --detach --network host

This assumes that RabbitMQ is running on the default port in the host computer and that the Archon controllers are accessible over the host network.


archon uses poetry for dependency management and packaging. To work with an editable install it's recommended that you setup poetry and install archon in a virtual environment by doing

poetry install

Or in editable mode

pip install -e .

Note that the latter will only install the production dependencies, not the development ones. You'll need to install those manually (see pyproject.toml []).

Style and type checking

This project uses the black code style with 88-character line lengths for code and docstrings. It is recommended that you run black on save. Imports must be sorted using isort. The GitHub test workflow checks all the Python file to make sure they comply with the black formatting.

Linting uses flake8 and isort rules implemented using ruff.

For Visual Studio Code, the following project file is compatible with the project configuration:

  "[python]": {
    "editor.formatOnSave": true,
    "editor.codeActionsOnSave": {
      "source.fixAll": "explicit",
      "source.organizeImports.ruff": "explicit"
    "editor.wordWrap": "off",
    "editor.tabSize": 4,
    "editor.defaultFormatter": ""
  "[markdown]": {
    "editor.wordWrapColumn": 88
  "[restructuredtext]": {
    "editor.wordWrapColumn": 88
  "[json]": {
    "editor.quickSuggestions": {
      "strings": true
    "editor.suggest.insertMode": "replace",
    "gitlens.codeLens.scopes": ["document"],
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "esbenp.prettier-vscode",
    "editor.tabSize": 2
  "[yaml]": {
    "editor.insertSpaces": true,
    "editor.formatOnSave": true,
    "editor.tabSize": 2,
    "editor.autoIndent": "advanced",
    "gitlens.codeLens.scopes": ["document"]
  "prettier.tabWidth": 2,
  "editor.rulers": [88],
  "editor.wordWrapColumn": 88,
  "python.analysis.typeCheckingMode": "basic"

This assumes that the Python and Pylance extensions are installed.

This project uses type hints.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sdss_archon-0.13.4.tar.gz (46.5 kB view hashes)

Uploaded Source

Built Distribution

sdss_archon-0.13.4-py3-none-any.whl (59.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page