Technical Documentation

Core

• app.engine package
  • endpoints
  • app.engine.all_engine_strategies
    • all_engine_strategies()
• app.repository package
  • Submodules
  • app.repository.base_repository module
    • BaseRepository
      • BaseRepository.session_factory
      • BaseRepository.model
      • BaseRepository.create()
      • BaseRepository.delete_by_id()
      • BaseRepository.read_by_column()
      • BaseRepository.read_by_columns()
      • BaseRepository.read_by_id()
      • BaseRepository.read_by_options()
      • BaseRepository.update()
      • BaseRepository.update_attr()
      • BaseRepository.whole_update()
  • app.repository.game_params_repository module
    • GameParamsRepository
      • GameParamsRepository.session_factory
      • GameParamsRepository.model
      • GameParamsRepository.patch_game_params_by_id()
  • app.repository.game_repository module
    • GameRepository
      • GameRepository.session_factory
      • GameRepository.model
      • GameRepository.model_tasks
      • GameRepository.model_game_params
      • GameRepository.delete_game_by_id()
      • GameRepository.get_all_games()
      • GameRepository.get_game_by_id()
      • GameRepository.patch_game_by_id()
  • app.repository.task_params_repository module
    • TaskParamsRepository
      • TaskParamsRepository.session_factory
      • TaskParamsRepository.model
  • app.repository.task_repository module
    • TaskRepository
      • TaskRepository.session_factory
      • TaskRepository.model
      • TaskRepository.get_points_and_users_by_taskId()
      • TaskRepository.read_by_gameId()
      • TaskRepository.read_by_gameId_and_externalTaskId()
  • app.repository.user_points_repository module
    • UserPointsRepository
      • UserPointsRepository.session_factory
      • UserPointsRepository.model
      • UserPointsRepository.task_repository
      • UserPointsRepository.user_repository
      • UserPointsRepository.count_measurements_by_external_task_id()
      • UserPointsRepository.count_personal_records_by_external_game_id()
      • UserPointsRepository.get_all_UserPoints_by_gameId()
      • UserPointsRepository.get_all_UserPoints_by_taskId()
      • UserPointsRepository.get_all_UserPoints_by_taskId_with_details()
      • UserPointsRepository.get_all_point_of_tasks_list()
      • UserPointsRepository.get_avg_time_between_tasks_by_user_and_game_task()
      • UserPointsRepository.get_avg_time_between_tasks_for_all_users()
      • UserPointsRepository.get_first_user_points_in_external_task_id_by_user_id()
      • UserPointsRepository.get_global_avg_by_external_game_id()
      • UserPointsRepository.get_global_calculation()
      • UserPointsRepository.get_individual_calculation()
      • UserPointsRepository.get_last_task_by_userId()
      • UserPointsRepository.get_last_window_time_diff()
      • UserPointsRepository.get_new_last_window_time_diff()
      • UserPointsRepository.get_personal_avg_by_external_game_id()
      • UserPointsRepository.get_points_and_users_by_taskId()
      • UserPointsRepository.get_points_of_simulated_task()
      • UserPointsRepository.get_start_time_for_last_task()
      • UserPointsRepository.get_task_and_sum_points_by_userId()
      • UserPointsRepository.get_task_by_externalUserId()
      • UserPointsRepository.get_time_taken_for_last_task()
      • UserPointsRepository.get_user_measurement_count()
      • UserPointsRepository.get_user_task_measurements()
      • UserPointsRepository.get_user_task_measurements_count()
      • UserPointsRepository.get_user_task_measurements_count_the_last_seconds()
      • UserPointsRepository.read_by_user_task_and_idempotency()
      • UserPointsRepository.user_has_record_before_in_externalTaskId_last_min()
  • app.repository.user_repository module
    • UserRepository
      • UserRepository.session_factory
      • UserRepository.model
      • UserRepository.create_user_by_externalUserId()
      • UserRepository.get_or_create_by_externalUserId()
  • app.repository.wallet_repository module
    • WalletRepository
      • WalletRepository.session_factory
      • WalletRepository.model
      • WalletRepository.upsert_points_balance()
  • app.repository.wallet_transaction_repository module
    • WalletTransactionRepository
      • WalletTransactionRepository.session_factory
      • WalletTransactionRepository.model
  • Module contents
    • AbuseLimitCounterRepository
      • AbuseLimitCounterRepository.increment_and_get()
    • ApiKeyRepository
      • ApiKeyRepository.session_factory
      • ApiKeyRepository.model
      • ApiKeyRepository.read_all()
    • ApiRequestsRepository
      • ApiRequestsRepository.session_factory
      • ApiRequestsRepository.model
    • BaseRepository
      • BaseRepository.session_factory
      • BaseRepository.model
      • BaseRepository.create()
      • BaseRepository.delete_by_id()
      • BaseRepository.read_by_column()
      • BaseRepository.read_by_columns()
      • BaseRepository.read_by_id()
      • BaseRepository.read_by_options()
      • BaseRepository.update()
      • BaseRepository.update_attr()
      • BaseRepository.whole_update()
    • DashboardRepository
      • DashboardRepository.get_dashboard_summary()
      • DashboardRepository.get_dashboard_summary_logs()
      • DashboardRepository.process_query()
    • GameParamsRepository
      • GameParamsRepository.session_factory
      • GameParamsRepository.model
      • GameParamsRepository.patch_game_params_by_id()
    • GameRepository
      • GameRepository.session_factory
      • GameRepository.model
      • GameRepository.model_tasks
      • GameRepository.model_game_params
      • GameRepository.delete_game_by_id()
      • GameRepository.get_all_games()
      • GameRepository.get_game_by_id()
      • GameRepository.patch_game_by_id()
    • KpiMetricsRepository
      • KpiMetricsRepository.session_factory
      • KpiMetricsRepository.model
    • LogsRepository
      • LogsRepository.session_factory
      • LogsRepository.model
    • OAuthUsersRepository
      • OAuthUsersRepository.session_factory
      • OAuthUsersRepository.model
      • OAuthUsersRepository.get_user_by_sub()
    • TaskParamsRepository
      • TaskParamsRepository.session_factory
      • TaskParamsRepository.model
    • TaskRepository
      • TaskRepository.session_factory
      • TaskRepository.model
      • TaskRepository.get_points_and_users_by_taskId()
      • TaskRepository.read_by_gameId()
      • TaskRepository.read_by_gameId_and_externalTaskId()
    • UptimeLogsRepository
      • UptimeLogsRepository.session_factory
      • UptimeLogsRepository.model
    • UserActionsRepository
      • UserActionsRepository.session_factory
      • UserActionsRepository.model
      • UserActionsRepository.add_action_in_task()
    • UserGameConfigRepository
      • UserGameConfigRepository.session_factory
      • UserGameConfigRepository.model
      • UserGameConfigRepository.get_all_users_by_gameId()
    • UserInteractionsRepository
      • UserInteractionsRepository.session_factory
      • UserInteractionsRepository.model
    • UserPointsRepository
      • UserPointsRepository.session_factory
      • UserPointsRepository.model
      • UserPointsRepository.task_repository
      • UserPointsRepository.user_repository
      • UserPointsRepository.count_measurements_by_external_task_id()
      • UserPointsRepository.count_personal_records_by_external_game_id()
      • UserPointsRepository.get_all_UserPoints_by_gameId()
      • UserPointsRepository.get_all_UserPoints_by_taskId()
      • UserPointsRepository.get_all_UserPoints_by_taskId_with_details()
      • UserPointsRepository.get_all_point_of_tasks_list()
      • UserPointsRepository.get_avg_time_between_tasks_by_user_and_game_task()
      • UserPointsRepository.get_avg_time_between_tasks_for_all_users()
      • UserPointsRepository.get_first_user_points_in_external_task_id_by_user_id()
      • UserPointsRepository.get_global_avg_by_external_game_id()
      • UserPointsRepository.get_global_calculation()
      • UserPointsRepository.get_individual_calculation()
      • UserPointsRepository.get_last_task_by_userId()
      • UserPointsRepository.get_last_window_time_diff()
      • UserPointsRepository.get_new_last_window_time_diff()
      • UserPointsRepository.get_personal_avg_by_external_game_id()
      • UserPointsRepository.get_points_and_users_by_taskId()
      • UserPointsRepository.get_points_of_simulated_task()
      • UserPointsRepository.get_start_time_for_last_task()
      • UserPointsRepository.get_task_and_sum_points_by_userId()
      • UserPointsRepository.get_task_by_externalUserId()
      • UserPointsRepository.get_time_taken_for_last_task()
      • UserPointsRepository.get_user_measurement_count()
      • UserPointsRepository.get_user_task_measurements()
      • UserPointsRepository.get_user_task_measurements_count()
      • UserPointsRepository.get_user_task_measurements_count_the_last_seconds()
      • UserPointsRepository.read_by_user_task_and_idempotency()
      • UserPointsRepository.user_has_record_before_in_externalTaskId_last_min()
    • UserRepository
      • UserRepository.session_factory
      • UserRepository.model
      • UserRepository.create_user_by_externalUserId()
      • UserRepository.get_or_create_by_externalUserId()
    • WalletRepository
      • WalletRepository.session_factory
      • WalletRepository.model
      • WalletRepository.upsert_points_balance()
    • WalletTransactionRepository
      • WalletTransactionRepository.session_factory
      • WalletTransactionRepository.model
• app.services package
  • Submodules
  • app.services.base_service module
    • BaseService
      • BaseService.repository
      • BaseService.add()
      • BaseService.get_by_id()
      • BaseService.get_list()
      • BaseService.patch()
      • BaseService.patch_attr()
      • BaseService.put_update()
      • BaseService.remove_by_id()
  • app.services.game_params_service module
    • GameParamsService
      • GameParamsService.game_params_repository
  • app.services.game_service module
    • GameService
      • GameService.game_repository
      • GameService.game_params_repository
      • GameService.task_repository
      • GameService.strategy_service
      • GameService.create()
      • GameService.delete_game_by_id()
      • GameService.get_all_games()
      • GameService.get_by_externalId()
      • GameService.get_by_gameId()
      • GameService.get_game_by_external_id()
      • GameService.get_strategy_by_externalGameId()
      • GameService.get_strategy_by_gameId()
      • GameService.get_tasks_by_gameId()
      • GameService.patch_game_by_externalGameId()
      • GameService.patch_game_by_id()
  • app.services.strategy_service module
    • StrategyService
      • StrategyService.None
      • StrategyService.get_Class_by_id()
      • StrategyService.get_strategy_by_id()
      • StrategyService.list_all_strategies()
  • app.services.task_service module
    • TaskService
      • TaskService.strategy_service
      • TaskService.task_repository
      • TaskService.game_repository
      • TaskService.user_repository
      • TaskService.user_points_repository
      • TaskService.game_params_repository
      • TaskService.task_params_repository
      • TaskService.create_task_by_externalGameId()
      • TaskService.create_task_by_game_id()
      • TaskService.get_points_by_task_id()
      • TaskService.get_points_by_task_id_with_details()
      • TaskService.get_points_of_user_by_task_id()
      • TaskService.get_task_by_externalGameId_externalTaskId()
      • TaskService.get_task_by_gameId_externalTaskId()
      • TaskService.get_task_detail_by_id()
      • TaskService.get_task_params_by_externalTaskId()
      • TaskService.get_tasks_list_by_externalGameId()
      • TaskService.get_tasks_list_by_gameId()
  • app.services.user_points_service module
    • UserPointsService
      • UserPointsService.assign_points_to_user()
      • UserPointsService.assign_points_to_user_directly()
      • UserPointsService.count_measurements_by_external_task_id()
      • UserPointsService.count_personal_records_by_external_game_id()
      • UserPointsService.get_all_point_of_tasks_list()
      • UserPointsService.get_all_points_by_externalUserId()
      • UserPointsService.get_avg_time_between_tasks_by_user_and_game_task()
      • UserPointsService.get_avg_time_between_tasks_for_all_users()
      • UserPointsService.get_global_avg_by_external_game_id()
      • UserPointsService.get_last_window_time_diff()
      • UserPointsService.get_new_last_window_time_diff()
      • UserPointsService.get_personal_avg_by_external_game_id()
      • UserPointsService.get_points_by_externalUserId()
      • UserPointsService.get_points_by_gameId()
      • UserPointsService.get_points_by_gameId_with_details()
      • UserPointsService.get_points_by_user_list()
      • UserPointsService.get_points_of_simulated_task()
      • UserPointsService.get_points_of_user()
      • UserPointsService.get_points_of_user_in_game()
      • UserPointsService.get_points_simulated_of_user_in_game()
      • UserPointsService.get_user_task_measurements()
      • UserPointsService.get_user_task_measurements_count()
      • UserPointsService.get_user_task_measurements_count_the_last_seconds()
      • UserPointsService.get_users_by_gameId()
      • UserPointsService.get_users_points_by_externalGameId()
      • UserPointsService.get_users_points_by_externalTaskId()
      • UserPointsService.get_users_points_by_externalTaskId_and_externalUserId()
      • UserPointsService.query_user_points()
      • UserPointsService.user_has_record_before_in_externalTaskId_last_min()
  • app.services.user_service module
    • UserService
      • UserService.user_repository
      • UserService.user_points_repository
      • UserService.task_repository
      • UserService.wallet_repository
      • UserService.wallet_transaction_repository
      • UserService.assign_points_to_user()
      • UserService.basic_engagement_points()
      • UserService.convert_points_to_coins()
      • UserService.convert_points_to_coins_externalUserId()
      • UserService.create_user()
      • UserService.get_points_by_user_id()
      • UserService.get_user_by_externalUserId()
      • UserService.get_wallet_by_externalUserId()
      • UserService.get_wallet_by_user_id()
      • UserService.global_advantage_adjustment_points()
      • UserService.individual_adjustment_points()
      • UserService.individual_over_global_points()
      • UserService.need_for_motivation_points()
      • UserService.peak_performer_bonus_points()
      • UserService.performance_bonus_points()
      • UserService.performance_penalty_points()
      • UserService.preview_points_to_coins_conversion()
      • UserService.preview_points_to_coins_conversion_externalUserId()
  • app.services.wallet_service module
    • WalletService
      • WalletService.wallet_repository
      • WalletService.user_repository
      • WalletService.get_wallet_by_user_id()
      • WalletService.preview_convert()
  • app.services.wallet_transaction_service module
    • WalletTransactionService
      • WalletTransactionService.wallet_transaction_repository
  • Module contents

Submodules

app.gunicorn_conf module

app.main module

app.main.custom_openapi()

Customizes the OpenAPI schema for the FastAPI application.

Returns:

The customized OpenAPI schema.

Return type:

dict

app.main.get_git_commit_hash() → str

Returns the current git commit hash, or “unknown” if not available.

Returns:

The current git commit hash, or “unknown” if not available.

Return type:

str

app.main.get_project_data()

Retrieves project data from the pyproject.toml file.

Returns:

Project data from the toml file.

Return type:

dict

app.main.get_swagger_oauth_config() → dict

Builds Swagger UI OAuth init configuration from environment-based settings.

Returns:

Swagger OAuth init configuration.

Return type:

dict

app.main.lifespan(app: FastAPI)

app.main.run_migrations()

Run alembic upgrade head on startup.

Creates all tables if the DB is fresh, or upgrades to the latest migration if the DB is behind. Safe to call multiple times (idempotent).

Module contents