Fink client
fink-client is a light package around Apache Kafka tools to manipulate catalogs and alerts issued from the 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:
pip install fink-client --upgrade
Documentation
Depending on the survey used, you will find documentation at:
| Service | Documentation links |
|---|---|
| Livestream | LSST / ZTF |
| Data Transfer | LSST / ZTF |
| Xmatch | LSST (incl. in Data Transfer) / ZTF |
Registration
In order to connect and poll alerts from Fink, you need to get your credentials:
- Subscribe to one or more Fink streams by filling this form.
- After filling the form, we will send your credentials. Register them on your machine following the ZTF or LSST documentation.
Contributing
For development, we recommend the use of a virtual environment:
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.
1 maintainer
Metadata
1 maintainer
Release files for fink-client 12.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fink_client-12.2.0.tar.gz | 39.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fink_client-12.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 90.1 kB
Release files / fink_client-12.2.0.tar.gz
| Download URL | fink_client-12.2.0.tar.gz |
|---|---|
| Size | 39.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
47f0a19f2118c0b1ada388f7a76ca214099a744b90a361356553eacd718ebecd
|
|
BLAKE2b-256 checksum How to use checksums |
d26846f38fea5d1f44e110629b086d85d26553930149851a99c02dc53d06c41c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.15
|
Release files / fink_client-12.2.0-py3-none-any.whl
| Download URL | fink_client-12.2.0-py3-none-any.whl |
|---|---|
| Size | 50.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ceb5af2f73b0a9e9f0eb240ec2ab89ae501f78a2621c101af9c2cfaa9adbd38a
|
|
BLAKE2b-256 checksum How to use checksums |
60c9b40f5830207e549fb3294c5c5d914d1c8f377307b11261bccdb320cc4f77
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.11.15
|
