archon
A library and actor to communicate with an STA Archon controller.
Installation
In general you should be able to install archon by doing
pip install sdss-archon
To build from source, use
git clone git@github.com:sdss/archon
cd archon
pip install .
Docker
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 ghcr.io/sdss/archon:latest
To run a container
docker run --name archon --rm --detach --network host ghcr.io/sdss/archon:latest
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.
Development
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 [tool.poetry.dev-dependencies]).
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": "ms-python.black-formatter"
},
"[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.
Release files for sdss-archon 0.15.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sdss_archon-0.15.5.tar.gz | 44.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sdss_archon-0.15.5-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 103.9 kB
Release files / sdss_archon-0.15.5.tar.gz
| Download URL | sdss_archon-0.15.5.tar.gz |
|---|---|
| Size | 44.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dc07f48857d0bfe9316d2a093666ccf9f048c8ac4b4fef85839088ce2c4e2bea
|
|
BLAKE2b-256 checksum How to use checksums |
461d37fe0dc42fc445911465ea3117b6e6ea75164098dbbaecbcab8b5e500c8a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 30, 2025.
Transparency logRelease files / sdss_archon-0.15.5-py3-none-any.whl
| Download URL | sdss_archon-0.15.5-py3-none-any.whl |
|---|---|
| Size | 59.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
72513b91820a3ac07c5aa299ba756437b10298535eb6b31cbf971234bfc0558e
|
|
BLAKE2b-256 checksum How to use checksums |
72ccbb6a7879deb3eb0f78a0eb2f80c94d8c29b1525970470726421c8c006e9e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 30, 2025.
Transparency log
