antares-client 1.14.0

A light-weight client for receiving alerts from ANTARES.

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
• Documentation
• Upgrading
• Troubleshooting

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.

1. Install dependencies

pip install ".[docs]"

2. Generate HTML build

make --directory docs html

3. Visit the build/index.html file 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.