How touero/opsariichthys-bidens works
Main Components
• API Layer:
• “api” directory, which houses the core functionality (api_core.py, api_master.py, constants_api.py).
• That it handles HTTP requests (GET/POST) and provides endpoints for accessing the various statistical datasets.
• Database Layer:
• “database” directory containing scripts like create_db.py, database.py, and model.py along with SQL scripts for both MySQL and SQLite.
• This component is responsible for establishing database connections, executing queries, and storing/retrieving statistical data.
• Logging Component:
• “logs” directory (with re_log.py) as the logging subsystem.
• This component captures and manages log information and error reporting for debugging and analytics.
• Deployment & Environment:
• Configuration and environment files like env.py and the GitHub workflows (located under .github/workflows) which illustrate CI/CD processes.
• Auxiliary or Driver Components:
• “local_driver.py” and “run.py” as entry points: run.py for local execution and docker_run.py for initiating the Docker container.
Architectural Patterns and Technologies
• That the system is designed with a layered architecture, where:
• The API layer acts as the controller/service entry point,
• The Database layer handles data access and persistence,
• And the Logging component manages monitoring and error reporting.
• Use of FastAPI as the main framework for the API layer.
• MySQL and SQLite as represented in the SQL scripts (and annotate which SQL flavor is used in each scenario).
• That Docker is used for environment encapsulation and streamlined deployment.