Metadata-Version: 2.1
Name: antares-client
Version: 1.0.6
Summary: A light-weight client for receiving alerts from ANTARES.
Home-page: https://gitlab.com/nsf-noirlab/csdc/antares/client/
Author: Nicholas Wolf
Author-email: nwolf@noao.edu
License: UNKNOWN
Platform: UNKNOWN
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE

# 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.0.6
```

## 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.



