src.api package

Subpackages

• src.api.adapters package
  • Subpackages
    • src.api.adapters.repositories package
      • Submodules
      • Module contents
  • Submodules
    • src.api.adapters.database_orm module
      • Base
      • EphemerisPointDb
      • InterpolableEphemerisDb
      • InterpolatedSplineDb
      • SatelliteDb
      • TLEDb
      • TdmPredictionDb
      • TdmPredictionPointDb
    • src.api.adapters.external_apis module
  • Module contents
• src.api.common package
  • Submodules
    • src.api.common.error_messages module
    • src.api.common.exceptions module
      • DataError
      • ValidationError
    • src.api.common.position_data_point module
      • position_data_point
  • Module contents
• src.api.domain package
  • Subpackages
    • src.api.domain.models package
      • Submodules
      • Module contents
  • Module contents
• src.api.entrypoints package
  • Subpackages
    • src.api.entrypoints.v1 package
      • Subpackages
      • Module contents
  • Submodules
    • src.api.entrypoints.extensions module
      • get_forwarded_address()
  • Module contents
• src.api.services package
  • Subpackages
    • src.api.services.tasks package
      • Submodules
      • Module contents
  • Submodules
    • src.api.services.ephemeris_service module
      • generate_ephemeris_data()
      • generate_ephemeris_data_user()
    • src.api.services.fov_service module
      • _cache_results()
      • _calculate_performance_metrics()
      • _check_cache_for_results()
      • _create_jd_list()
      • _get_tle_data()
      • _log_fov_parameters()
      • get_satellite_passes_in_fov()
      • get_satellite_passes_in_fov_async()
      • get_satellites_above_horizon()
    • src.api.services.tools_service module
      • get_active_satellites()
      • get_adjacent_tle_results()
      • get_all_tles_at_epoch_formatted()
      • get_ids_for_satellite_name()
      • get_names_for_satellite_id()
      • get_nearest_tle_result()
      • get_satellite_data()
      • get_starlink_generations()
      • get_tle_data()
      • get_tles_around_epoch_results()
      • search_all_satellites()
    • src.api.services.validation_service module
      • extract_parameters()
      • jd_arange()
      • parse_tle()
      • validate_parameters()
  • Module contents
• src.api.utils package
  • Submodules
    • src.api.utils.coordinate_systems module
      • az_el_to_ra_dec()
      • calculate_current_position()
      • ecef_to_eci()
      • ecef_to_enu()
      • ecef_to_itrs()
      • enu_to_az_el()
      • get_earth_sun_positions()
      • get_phase_angle()
      • icrf2radec()
      • is_illuminated()
      • is_illuminated_vectorized()
      • itrs_to_gcrs()
      • load_earth_sun()
      • radec2icrf()
      • teme_to_ecef()
      • tle_to_icrf_state()
    • src.api.utils.output_utils module
      • format_date()
      • fov_data_to_json()
      • position_data_to_json()
      • satellite_data_to_json()
    • src.api.utils.propagation_strategies module
      • BasePropagationStrategy
      • FOVParallelPropagationStrategy
      • FOVPropagationStrategy
      • KroghPropagationStrategy
      • PropagationInfo
      • SGP4PropagationStrategy
      • SkyfieldPropagationStrategy
      • TestPropagationStrategy
      • get_timescale()
      • process_satellite_batch()
      • satellite_position
    • src.api.utils.time_utils module
      • astropy_time_to_datetime_utc()
      • calculate_lst()
      • ensure_datetime()
      • jd_to_gst()
  • Module contents

Submodules

• src.api.celery_app module
  • make_celery()
• src.api.config module
  • get_db_login()
• src.api.satchecker module

Module contents

API package initialization.

class src.api.JSONFormatter

Bases: Formatter

ANSI_ESCAPE = re.compile('\\x1b\\[[0-9;]*m')

format(record)

Format the specified record as text.

The record’s attribute dictionary is used as the operand to a string formatting operation which yields the returned string. Before formatting the dictionary, a couple of preparatory steps are carried out. The message attribute of the record is computed using LogRecord.getMessage(). If the formatting string uses the time (as determined by a call to usesTime(), formatTime() is called to format the event time. If there is exception information, it is formatted using formatException() and appended to the message.

src.api.create_app(test_config=None)

Create and configure the Flask application.

src.api.setup_logging(app)

Set up logging based on the running environment.