Metadata-Version: 2.1
Name: antares-client
Version: 1.10.0
Summary: A light-weight client for receiving alerts from ANTARES.
Keywords: antares
Author-Email: NSF NOIRLab ANTARES Team <antares@noirlab.edu>
Maintainer-Email: NSF NOIRLab ANTARES Team <antares@noirlab.edu>
License: MIT License
         
         Copyright (c) 2020 Association of Universities for Research in Astronomy, Inc.
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
         
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.9
Project-URL: Homepage, https://gitlab.com/nsf-noirlab/csdc/antares/client
Project-URL: Documentation, https://nsf-noirlab.gitlab.io/csdc/antares/client
Project-URL: Bug Reports, https://gitlab.com/nsf-noirlab/csdc/antares/client/-/issues
Project-URL: Source, https://gitlab.com/nsf-noirlab/csdc/antares/client
Requires-Python: >=3.9
Requires-Dist: astropy
Requires-Dist: bson
Requires-Dist: click
Requires-Dist: marshmallow<4,>=3.6
Requires-Dist: marshmallow-jsonapi>=0.23
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: requests
Requires-Dist: typing-extensions
Requires-Dist: astropy-healpix
Provides-Extra: dev
Requires-Dist: black; extra == "dev"
Requires-Dist: pylint; extra == "dev"
Requires-Dist: isort; extra == "dev"
Provides-Extra: test
Requires-Dist: coverage==7.2.7; extra == "test"
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: requests-mock; extra == "test"
Provides-Extra: subscriptions
Requires-Dist: confluent_kafka==1.7.0; extra == "subscriptions"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-click; extra == "docs"
Description-Content-Type: text/markdown

# antares-client

A light-weight client for receiving alerts from
[ANTARES](http://antares.noirlab.edu).

ANTARES is an Alert Broker developed by the [NSF NOIRLab](http://noirlab.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
```

To install with kafka to use the StreamingClient:

```bash
$ pip install "antares-client[subscriptions]"
```

Verify the client installed correctly:

```bash
$ antares --version
antares, version v1.1.0
```

## Documentation

Visit the [full documentation](https://nsf-noirlab.gitlab.io/csdc/antares/client) for usage
guides, API reference docs, and more.

## Development

To install the development dependencies
```bash
pip install uv
uv sync --all-groups --all-extras
```

## Troubleshooting

Issues? See the
[documentation](https://nsf-noirlab.gitlab.io/csdc/antares/client/troubleshooting) for
common gotchas and, if you can't find a solution there, please open an issue.

