Metadata-Version: 2.5
Name: fink-client
Version: 12.1.0
Summary: Light-weight client to manipulate alerts from Fink
Author-email: Julien Peloton <peloton@ijclab.in2p3.fr>
Maintainer-email: Julien Peloton <peloton@ijclab.in2p3.fr>
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-Expression: Apache-2.0
License-File: LICENSE
Requires-Dist: rich-click>=1.9.7
Requires-Dist: astropy>=6.1.7
Requires-Dist: confluent-kafka>=2.14.0
Requires-Dist: fastavro>=1.9.4,<2.0.0
Requires-Dist: numpy>=1.23.5
Requires-Dist: pandas>=1.3.5
Requires-Dist: pyarrow>=9.0.0
Requires-Dist: slack_sdk
Requires-Dist: matplotlib
Requires-Dist: PyYAML
Requires-Dist: tabulate
Requires-Dist: tqdm
Requires-Dist: psutil
Requires-Dist: requests
Requires-Dist: coverage ; extra == "dev"
Requires-Dist: coveralls ; extra == "dev"
Requires-Dist: ruff ; extra == "dev"
Project-URL: Changelog, https://github.com/astrolabsoftware/fink-client/releases
Project-URL: Documentation, https://doc.lsst.fink-broker.org/services/summary/
Project-URL: Homepage, https://github.com/astrolabsoftware/fink-client
Project-URL: Issues, https://github.com/astrolabsoftware/fink-client/issues
Project-URL: Repository, https://github.com/astrolabsoftware/fink-client
Provides-Extra: dev
Import-Name: fink_client

[![pypi](https://img.shields.io/pypi/v/fink-client.svg)](https://pypi.python.org/pypi/fink-client)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fink-client&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fink-client)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=fink-client&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=fink-client)
[![Sentinel](https://github.com/astrolabsoftware/fink-client/workflows/Sentinel/badge.svg)](https://github.com/astrolabsoftware/fink-client/actions?query=workflow%3ASentinel)

# Fink client

`fink-client` is a light package around Apache Kafka tools to manipulate catalogs and alerts issued from the [fink broker](https://github.com/astrolabsoftware/fink-broker) programmatically. It is used in the context of 3 major Fink services: Livestream, Data Transfer, and Xmatch.

## Installation

`fink_client` requires a version of Python 3.9+. You can easily install it via pip:

```bash
pip install fink-client --upgrade
```

## Documentation

Depending on the survey used, you will find documentation at:

| Service | Documentation links |
|-|-|
| Livestream | [LSST](https://doc.lsst.fink-broker.org/services/livestream/) / [ZTF](https://doc.ztf.fink-broker.org/services/livestream/) |
| Data Transfer | [LSST](https://doc.lsst.fink-broker.org/services/data_transfer/) / [ZTF](https://doc.ztf.fink-broker.org/services/data_transfer/) |
| Xmatch | [LSST](https://doc.lsst.fink-broker.org/services/data_transfer/) (incl. in Data Transfer) / [ZTF](https://doc.ztf.fink-broker.org/services/xmatch/) |


## Registration

In order to connect and poll alerts from Fink, you need to get your credentials:

1. Subscribe to one or more Fink streams by filling this [form](https://forms.gle/2td4jysT4e9pkf889).
2. After filling the form, we will send your credentials. Register them on your machine following the [ZTF](https://doc.ztf.fink-broker.org/services/fink_client/) or [LSST](https://doc.lsst.fink-broker.org/services/fink_client/) documentation.

## Contributing

For development, we recommend the use of a virtual environment:

```bash
git clone https://github.com/astrolabsoftware/fink-client.git
cd fink-client
python -m venv .fc_env
source .fc_env/bin/activate
pip install -r requirements.txt
pip install .
```

Feel free to open a Pull Request for bug fixes or new features.

