Skip to main content

Fink broker module for the TOM Toolkit

Project description

Fink Alert Broker Module for the TOM Toolkit

pypi Codacy Badge Coverage Status

This repository hosts the Fink Alert Broker Module for the TOM Toolkit. Fink is a broker currently connected to ZTF. More information on Fink at

As of version 0.4, the module simply uses the Fink REST API to retrieve alerts. Note that the Fink databases are updated once a day with the previous night alert data (hence you do not get live alerts for the moment). Users can perform:

  • Search by ZTF object ID
  • Cone Search
  • Search by Date
  • Search by derived alert class
  • Search by Solar System name

How to use the Fink module inside your TOM

First, install the module using pip

pip install tom-fink

then you need to declare it in your running TOM instance. To do so just add tom_fink.fink.FinkBroker to the TOM_ALERT_CLASSES in your TOM's


and finally relaunch your TOM:

./ runserver

Todo list

  • Add a test suite (preferably running on GitHub Actions)
  • Add a linter (preferably running on GitHub Actions)
  • Update the Query Form with all API features
  • Enable querying livestreams using the Fink Kafka client

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tom-fink-0.4.5.tar.gz (22.4 kB view hashes)

Uploaded source

Built Distribution

tom_fink-0.4.5-py3-none-any.whl (21.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page