Broker audit -- ensure broker modules have proper form validation, testing, and documentation.

[jchate6]

Broker audit -- ensure broker modules have proper form validation, dependencies, testing, and documentation.

• Install and configure each Broker on TOM Demo
• • ALeRCE --> tom_alerts
• • ANTARES --> tom_alerts
• • Lasair --> tom_alerts
• • Hermes --> tom_hermes
• • Scout --> tom_alerts (Not Including)
• • TNS --> tom_alerts
• • Fink --> tom_fink
• • Gaia --> tom_alerts
• Check and update documentation
• • ALeRCE
• • ANTARES
• • Lasair
• • Hermes
• • Scout
• • TNS
• • Fink
• • Gaia
• Test each broker to make sure it behaves as expected
• • ALeRCE
• • ANTARES
• • Lasair
• • Hermes
• • Scout
• • TNS
• • Fink
• • Gaia
• Update Canary tests
• • ALeRCE
• • ANTARES
• • Lasair
• • Hermes
• • Scout
• • TNS
• • Fink
• • Gaia
• address and/or prioritize broker issues
• Investigate Pitt-Google Broker
• Develop regular maintenance strategy
• Review tom_alerts_dash

[jchate6]

I'm failing to find any basic information about setting up a Broker (TNS, ALeRCE, Lasair, etc.) in the documentation.
This should be made more explicit.

For example,
TNS requires the following in settings.py:

BROKERS = {
    'TNS': {
        'api_key': TNS_API_KEY,
        'bot_id': <<bot_id>>,
        'bot_name': <<bot_name>>,
    }
}

[jchate6]

Related to TOMToolkit/tom_fink#24

[jchate6]

Look into more modern ways to access the Gaia Broker Data.

[jchate6]

Ensure Every Broker links to documentation. (Issue #271 )

[jchate6]

Related Issues:

• PRIORITY Update Broker Data Crashes in tom-demo-dev #792
• Include Instrument and Telescope information for Reduced Datums ingested from Brokers and Forced photometry #762
• Alerce query fails with error from tom-demo-dev #601
• Review Lasair broker module to ensure compatibility with upgraded service #620
• Clarify functionality of update broker data button on targetlist page #623
• Brokers should not throw exceptions on attempted creation of duplicate objects #253
• Every broker should show a link to documentation #271
• Add Classification as a field on GenericAlert? #479
• Coverage tests broken for Tom_Fink tom_fink#34
• Handle Fink livestreams tom_fink#24
• improve the error messages when the user write a failed query tom_fink#29
• Clean date function for TargetExtra tom_fink#30
• Update tom_base requirement and fix score tom_fink#36
• Antares_client incompatible with python>3.10 without librdkafka tom_antares#41
• Feature Request: Add search Capabilities tom_antares#28
• Revitalize Tom_alerts_dash tom_alerts_dash#33
• Time Filter Dates are not loaded correctly when editing a saved query. tom_hermes#3
• TOM-Fink should automatically release to pypi tom_fink#38
• Better error handling in tom_alerts #1060
• Add integration tests to TOM Data Services #1061

We will also want to make sure TOM Toollkit dependencies are up to date for

• tom_fink
• tom_antares
• tom_hermes

[jchate6]

Look into Pitt-Google Tom Broker
https://github.com/mwvgroup/tom_pittgoogle

[jchate6]

List of supported Brokers

• ALeRCE
• ANTARES
• Lasair
• Hermes
• Scout
• TNS
• Fink
• Gaia

[jchate6]

Also figure out what Scout (the Broker module) does.
(see ssd-api.jpl.nasa.gov/doc/scout.html) and document it.

• document Scout Broker query form
• add new parameters to Scout Broker query form as appropriate
• Re-evaluate the use of scout Broker.

#837