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.1
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.1.tar.gz | 17.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| antares_client-2.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 39.7 kB
Release files / antares_client-2.0.1.tar.gz
| Download URL | antares_client-2.0.1.tar.gz |
|---|---|
| Size | 17.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c0748facdb1af9e0f3cca066421c25f6e7196fb5ac14de3f31f93398ed8588cf
|
|
BLAKE2b-256 checksum How to use checksums |
2e27df4fc5c47236bfdbddc9c4f3c8c94e8a10b8751f112ed3748b6e09877e1e
|
| 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.1-py3-none-any.whl
| Download URL | antares_client-2.0.1-py3-none-any.whl |
|---|---|
| Size | 22.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
81c36ec961af2a06e29aae21c19ce6afa8cc855b46b90d40fc07076fd59536fa
|
|
BLAKE2b-256 checksum How to use checksums |
7b59f0d92cf92a6a0edd97a797b9a4325c8efae10d93837b3276340a3257250d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
