Skip to main content

Python Versions PyPI version Build Status Documentation Status Coverage Status zenodo

CLU implements a new protocol for SDSS actor while providing support for legacy-style actor.

Features

  • Asynchronous API based on asyncio.

  • New-style actor with message passing based on AMQP and RabbitMQ.

  • Legacy-style actor for TCP socket communication via tron.

  • Tools for device handling.

  • Messages are validated JSON strings.

  • click-enabled command parser.

Installation

CLU can be installed using pip as

pip install sdss-clu

or from source

git clone https://github.com/sdss/clu
cd clu
pip install .

Development

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

uv sync --all-groups --all-extras

although it is also possible to install it using pip in editable mode

pip install -e .

We use ruff for linting and formatting. To check that your code conforms to the style guide run

ruff check python tests
ruff format --check python tests

Quick start

Creating a new actor with CLU is easy. To instantiate and run an actor you can simply do

import asyncio
from clu import AMQPActor

async def main(loop):
    actor = await Actor('my_actor').start()
    await actor.run_forever()

asyncio.run(main(loop))

Next, head to the Getting started section for more information about using actors. More examples are available here.

Why a new messaging protocol for SDSS?

Say whatever you want about it, the current SDSS message passing protocol based on Tron, opscore, and actorcore is stable and robust. So, why should we replace it? Here is a list of reasons:

  • It reinvents the wheel. Ok, in all honesty Tron and opscore were written when wheel were still not completely circular, but the truth is that nowadays there are more robust, standard, and better documented technologies out there for message passing.

  • We can remove the need for a central hub product by relying in open-source message brokers such as RabbitMQ.

  • Tron and opscore are Python 2 and it’s unclear the amount of effort that would be needed to convert them to Python 3.

  • While there is some documentation for Tron and opscore, and the code is well written, it’s also cumbersome and difficult to modify by people that didn’t write it. It’s ultimately non-maintainable.

  • The opsctore/actorkeys datamodel is custom-built and extremely difficult to maintain. Standard solutions such as JSON with a JSON schema validator should be preferred.

  • asyncio provides an asynchronous API that is cleaner and easier to code than using threads. It is also more readable and less convoluted than twisted and it’s a Python core library with very active development.

  • CLU uses click for parsing commands, providing a well-defined, easy to use parser.

Release files for sdss-clu 2.6.1

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

Source distribution (sdist)

Source distribution for sdss-clu 2.6.1
File Size Uploaded
sdss_clu-2.6.1.tar.gz 124.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sdss-clu 2.6.1
File Interpreter ABI Platform
sdss_clu-2.6.1-py3-none-any.whl Python 3 none any Details

Total release size: 267.2 kB

Release files / sdss_clu-2.6.1.tar.gz

Download URL sdss_clu-2.6.1.tar.gz
Size 124.0 kB
Tags Source
SHA-256 checksum
How to use checksums
c99c285dfe802ca1509eacc250081d48c3f96111a4ad59bf419f6380b84b26c8
BLAKE2b-256 checksum
How to use checksums
1968abd7a7b71a41700863db4e679adadc4605d8bde65248835f67da8e121a98
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

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 Feb 6, 2026.

Transparency log

Release files / sdss_clu-2.6.1-py3-none-any.whl

Download URL sdss_clu-2.6.1-py3-none-any.whl
Size 143.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
098594aa4fa9ef847bd176f55d2e072b3e503202034cf841597880ff475f8fca
BLAKE2b-256 checksum
How to use checksums
babe25dda3c989b9fe234b7b769388e74a00aac21fc51df1620c188f6baa65d4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

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 Feb 6, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

2.6.1 This release

2 release files

2.6.0

2 release files

2.5.3

2 release files

2.5.2

2 release files

2.5.1

2 release files

2.5.0

2 release files

2.4.3

2 release files

2.4.2

2 release files

2.4.1

2 release files

2.4.0

2 release files

2.3.1

2 release files

2.3.0

2 release files

2.2.7

2 release files

2.2.6

2 release files

2.2.5

2 release files

2.2.4

2 release files

2.2.3

2 release files

2.2.2

2 release files

2.2.1

2 release files

2.2.0

2 release files

2.1.3

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.9.2

2 release files

1.9.1

2 release files

1.9.0

2 release files

1.8.2

2 release files

1.8.1

2 release files

1.8.0

2 release files

1.7.0

2 release files

1.6.2

2 release files

1.6.1

2 release files

1.6.0

2 release files

1.5.8

2 release files

1.5.7

2 release files

1.5.6

2 release files

1.5.5

2 release files

1.5.4

2 release files

1.5.3

2 release files

1.5.2

2 release files

1.5.1

2 release files

1.5.0

2 release files

1.4.0

2 release files

1.3.0

2 release files

1.2.1

2 release files

1.2.0

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1.0

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

0.9.1

2 release files

0.9.0

2 release files

0.8.1

2 release files

0.8.0

2 release files

0.7.8

2 release files

0.7.7

2 release files

0.7.6

2 release files

0.7.5

2 release files

0.7.4

2 release files

0.7.3

2 release files

0.7.2

2 release files

0.7.1

2 release files

0.7.0

2 release files

0.6.3

2 release files

0.6.2

2 release files

0.6.1

2 release files

0.6.0

2 release files

0.5.8

2 release files

0.5.7

2 release files

0.5.6

2 release files

0.5.5

2 release files

0.5.4

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.3

2 release files

0.3.1

2 release files

0.3.0

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.12

2 release files

0.1.11

2 release files

0.1.10

2 release files

0.1.9

2 release files

0.1.8

2 release files

0.1.7

1 release file

0.1.6

1 release file

0.1.5

2 release files

0.1.4

2 release files

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