TOMToolkit / tom_base

The base Django project for a Target and Observation Manager
https://tom-toolkit.readthedocs.io
GNU General Public License v3.0
26 stars 46 forks source link

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

Open jchate6 opened 1 year ago

jchate6 commented 1 year ago

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

jchate6 commented 1 year ago

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 commented 10 months ago

Related to TOMToolkit/tom_fink#24

jchate6 commented 10 months ago

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

jchate6 commented 10 months ago

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

jchate6 commented 10 months ago

Related Issues:

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

jchate6 commented 10 months ago

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

jchate6 commented 9 months ago

List of supported Brokers

jchate6 commented 9 months ago

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

837