antares-client
A light-weight client for receiving alerts from ANTARES.
ANTARES is an Alert Broker developed by the NSF NOIRLab for ZTF and LSST.
The client is available for use as a Python library and as a command line tool. Directions for both use cases follow in the Usage section.
Table of Contents:
Installation
The ANTARES client supports Python versions 3.6 and up.
To install:
$ pip install antares-client
To install with kafka to use the StreamingClient:
$ pip install "antares-client[subscriptions]"
Verify the client installed correctly:
$ antares --version
antares, version v1.1.0
Documentation
Visit the full documentation for usage guides, API reference docs, and more.
Development
To install the development dependencies
pip install uv
uv sync --all-groups --all-extras
Docs
Use the steps below to generate the docs locally. Note the docs are deployed to Gitlab pages using a manual trigger via the Gitlab pipeline.
- Install dependencies
pip install ".[docs]"
- Generate HTML build
make --directory docs html
- Visit the
build/index.htmlfile in the browser
firefox docs/build/html/index.html
Troubleshooting
Issues? See the documentation for common gotchas and, if you can't find a solution there, please open an issue.
1 maintainer
Metadata
1 maintainer
Release files for antares-client 2.0.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| antares_client-2.0.0.tar.gz | 17.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| antares_client-2.0.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 39.6 kB
Release files / antares_client-2.0.0.tar.gz
| Download URL | antares_client-2.0.0.tar.gz |
|---|---|
| Size | 17.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
011e697f33a9f7ca1d61d704617809a74958bd4110c55ff49668f6f55887a78c
|
|
BLAKE2b-256 checksum How to use checksums |
2d0001feb417855484539c29a8b9e938fc71609cb23fc56cb4c7af2f2963ff7c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / antares_client-2.0.0-py3-none-any.whl
| Download URL | antares_client-2.0.0-py3-none-any.whl |
|---|---|
| Size | 22.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0a226fd2d90e464996abc8f89d57e58957931bd504c63fe756ddf6ef3ddac427
|
|
BLAKE2b-256 checksum How to use checksums |
f8243e53da01b753ec8d8798cc6b37a48ee3f5d7571593ff5f6a5b26ebfc528b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
