altimeter.qj.api package

Subpackages

• altimeter.qj.api.base package
  • Subpackages
    • altimeter.qj.api.base.endpoints package
      • Submodules
      • altimeter.qj.api.base.endpoints.auth module
      • altimeter.qj.api.base.endpoints.status module
      • Module contents
  • Submodules
  • altimeter.qj.api.base.api module
  • Module contents
• altimeter.qj.api.v1 package
  • Subpackages
    • altimeter.qj.api.v1.endpoints package
      • Submodules
      • altimeter.qj.api.v1.endpoints.jobs module
      • altimeter.qj.api.v1.endpoints.result_sets module
      • Module contents
  • Submodules
  • altimeter.qj.api.v1.api module
  • Module contents

Submodules

altimeter.qj.api.deps module

FastAPI dependencies

class SessionGenerator

Bases: object

Singleton class for generating db sesssions

get_session()

Get a db session object

Return type

Session

api_key(key=Depends(APIKeyHeader))

Validate an api key string matches the value currently in SecretsManager

Return type

str

db_session()

Get a db session

Return type

Generator[Session, None, None]

job_crud()

Get a CRUDJob object

Return type

CRUDJob

result_set_crud()

Get a CRUDResultSet object

Return type

CRUDResultSet

Module contents