foca package
FOCA root package.
Subpackages
- foca.api package
- foca.config package
- foca.database package
- foca.errors package
- foca.factories package
- foca.models package
- Submodules
- foca.models.config module
APIConfig
AccessControlConfig
AccessControlConfig.api_specs
AccessControlConfig.api_controllers
AccessControlConfig.db_name
AccessControlConfig.collection_name
AccessControlConfig.model
AccessControlConfig.owner_headers
AccessControlConfig.user_headers
AccessControlConfig.api_controllers
AccessControlConfig.api_specs
AccessControlConfig.collection_name
AccessControlConfig.db_name
AccessControlConfig.model
AccessControlConfig.owner_headers
AccessControlConfig.user_headers
AccessControlConfig.validate_model_path()
AuthConfig
AuthConfig.required
AuthConfig.add_key_to_claims
AuthConfig.allow_expired
AuthConfig.audience
AuthConfig.claim_identity
AuthConfig.claim_issuer
AuthConfig.algorithms
AuthConfig.validation_methods
AuthConfig.validation_checks
AuthConfig.add_key_to_claims
AuthConfig.algorithms
AuthConfig.allow_expired
AuthConfig.audience
AuthConfig.claim_identity
AuthConfig.claim_issuer
AuthConfig.required
AuthConfig.validation_checks
AuthConfig.validation_methods
CORSConfig
CollectionConfig
Config
DBConfig
ExceptionConfig
ExceptionConfig.required_members
ExceptionConfig.extension_members
ExceptionConfig.status_member
ExceptionConfig.public_members
ExceptionConfig.private_members
ExceptionConfig.exceptions
ExceptionConfig.logging
ExceptionConfig.mapping
ExceptionConfig.exceptions
ExceptionConfig.extension_members
ExceptionConfig.logging
ExceptionConfig.mapping
ExceptionConfig.private_members
ExceptionConfig.public_members
ExceptionConfig.required_members
ExceptionConfig.status_member
ExceptionConfig.validate_mapping()
ExceptionLoggingEnum
FOCABaseConfig
IndexConfig
JobsConfig
LogConfig
LogFormatterConfig
LogHandlerConfig
LogRootConfig
MongoConfig
PymongoDirectionEnum
PymongoDirectionEnum.ASCENDING
PymongoDirectionEnum.DESCENDING
PymongoDirectionEnum.GEO2D
PymongoDirectionEnum.GEOHAYSTACK
PymongoDirectionEnum.GEOSPHERE
PymongoDirectionEnum.HASHED
PymongoDirectionEnum.TEXT
PymongoDirectionEnum.ASCENDING
PymongoDirectionEnum.DESCENDING
PymongoDirectionEnum.GEO2D
PymongoDirectionEnum.GEOHAYSTACK
PymongoDirectionEnum.GEOSPHERE
PymongoDirectionEnum.HASHED
PymongoDirectionEnum.TEXT
SecurityConfig
ServerConfig
SpecConfig
SpecConfig.path
SpecConfig.path_out
SpecConfig.append
SpecConfig.add_operation_fields
SpecConfig.add_security_fields
SpecConfig.disable_auth
SpecConfig.connexion
SpecConfig.add_operation_fields
SpecConfig.add_security_fields
SpecConfig.append
SpecConfig.connexion
SpecConfig.disable_auth
SpecConfig.path
SpecConfig.path_out
SpecConfig.set_abs_path()
SpecConfig.set_default_out_path()
ValidationChecksEnum
ValidationMethodsEnum
- foca.security package
- foca.utils package
Submodules
foca.foca module
Class for setting up and initializing a FOCA-based microservice.
- class foca.foca.Foca(config_file: Path | None = None, custom_config_model: str | None = None)
Bases:
object
- create_app() FlaskApp
Set up and initialize FOCA-based Connexion app.
- Returns:
Connexion application instance.
- create_celery_app() Celery
Set up and initialize FOCA-based Celery app.
- Returns:
Celery application instance.
foca.version module
Single source of truth for package version.