-
Notifications
You must be signed in to change notification settings - Fork 0
Project Structure
Cecilia Wong edited this page May 1, 2024
·
4 revisions
| File/Directory | Description |
|---|---|
| App.py | Main Python module for the webservice. |
| honbasho_calendar.py | Module for operations related to the Grand Sumo Tournament schedule. Used by endpoint /getSumoHonbashoSchedule. |
| flaskapp/__init__.py | Python file related to Flask app initialization. |
| data/ | Directory for the data file(s) used by the webservice. |
| devtest_helper.py | Functions that provide features that aid development testing. |
| File/Directory | Description |
|---|---|
| config.ini | App configurations shared among all environments. |
| flaskapp/.env | Environment variable configuration for local development environments. |
| File/Directory | Description |
|---|---|
| __tests__/ | Directory for the test cases for Python modules. |
| api/doc/swagger.yaml | Swagger UI YAML file for the API documentation accessible from <base URL>/api/doc. |
| File/Directory | Description |
|---|---|
| Dockerfile compose.yaml |
Docker deployment configuration files. |
| requirements.txt | Dependency library declaration used during Docker deployment. When running the webapp with the Python command line, you may run pip install -r requirements.txt to install the dependencies. |
| docker-python-kubernetes.yaml | Configuration file for running Kubernetes at your local machine's Docker Desktop. |
| .dockerignore | Configures the files and directories to ignore on Docker deployment. |
| File/Directory | Description |
|---|---|
| README.md | The contents of this repository's README section. |
| .github/workflows/ | Path for GitHub workflow configuration(s). |
| docs/ | Files related to the API documentation hosted at this repository's GitHub pages. The swagger.yaml here will be updated to align with the one at api/doc/. |