⚠️ Important:
We have released a new version of our API, and all versions of this package prior to 2.0 will stop being supported November 4, 2026. These versions use the v1 API, which is being retired.
What this means for you
- Versions earlier than 2.0 will stop working
What's changing in version 2.0
- New API version: The package now uses the new API instead of v1.
- Pydantic replaces Marshmallow: Responses are now deserialized with Pydantic instead of Marshmallow.
What you need to to
- Upgrade to version 2.0 or later:
pip install --upgrade antares-client
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.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| antares_client-2.0.2.tar.gz | 17.9 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| antares_client-2.0.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 40.5 kB
Release files / antares_client-2.0.2.tar.gz
| Download URL | antares_client-2.0.2.tar.gz |
|---|---|
| Size | 17.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4ade0a6fe2a400c877cf22b0faec0fb3363756d92d5601d38700b759422bfcbc
|
|
BLAKE2b-256 checksum How to use checksums |
30a26183543f53fc4cb62109237ed049e9ecf8453c45f8851096a5b5b856ae14
|
| 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.2-py3-none-any.whl
| Download URL | antares_client-2.0.2-py3-none-any.whl |
|---|---|
| Size | 22.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c20fc7cabd292652055adea11769583f441a0ae578ccaf075b83d77885d441a5
|
|
BLAKE2b-256 checksum How to use checksums |
0fd44425bf357f645b15e9377ecd90cfd1d8040c8b4db883a2e9d9cdfbd584f4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Security for antares-client 2.0.2
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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
