https://github.com/lsst-epo/alerts-streaming-client

https://github.com/lsst-epo/alerts-streaming-client

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/lsst-epo/alerts-streaming-client
• Owner: lsst-epo
• Created: 2022-06-03T22:21:22.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-10-11T21:11:44.000Z (about 2 years ago)
• Last Synced: 2023-02-27T08:46:35.996Z (over 1 year ago)
• Language: Python
• Size: 28.3 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# antares-client

A light-weight client for receiving alerts from

[ANTARES](http://antares.noao.edu).

ANTARES is an Alert Broker developed by the [NOAO](http://noao.edu) 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](#usage) section.

Table of Contents:

* [Installation](#installation)

* [Documentation](#documentation)

* [Upgrading](#upgrading)

* [Troubleshooting](#troubleshooting)

## Installation

The ANTARES client supports Python versions 3.6 and up.

To install:

```bash

$ pip install antares-client

```

Verify the client installed correctly:

```bash

$ antares --version

antares, version v1.1.0

```

If installing with Python 3.10, `librdkafka` is required:

Mac: `brew install librdkafka`

Ubuntu: `apt-get install librdkafka-dev`

## Documentation

Visit the [full documentation](https://noao.gitlab.io/antares/client) for usage

guides, API reference docs, and more.

## Troubleshooting

Issues? See the

[documentation](https://noao.gitlab.io/antares/client/troubleshooting) for

common gotchas and, if you can't find a solution there, please open an issue.