Relocated app.py & config.yaml to repo root

paul-florentin-charles · Nov 29, 2023 · ab66ae8 · ab66ae8
1 parent cf1a524
commit ab66ae8
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,11 +1,16 @@
 # bcn-rainfall-models
 
- [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![coverage badge](coverage.svg)](https://github.com/nedbat/coveragepy)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
 🚧 WIP 🚧
 
+## Requirements
+
+- Python 3
+- Pip
+
 ## Get started
 
 1. Clone repository
@@ -18,7 +23,6 @@
 git clone https://github.com/paul-florentin-charles/bcn-rainfall-models.git
 cd bcn-rainfall-models
 pip3 install -r requirements.txt
-cd src
 python3 app.py
 ```
 
@@ -27,6 +31,5 @@ python3 app.py
 git clone https://github.com/paul-florentin-charles/bcn-rainfall-models.git
 cd bcn-rainfall-models
 python3 -m pip install -r requirements.txt
-cd src
 python3 app.py
 ```
diff --git a/src/app.py → app.py b/src/app.py → app.py
@@ -37,7 +37,7 @@
 )
 
 app = Flask(__name__)
-swagger = Swagger(app, template_file=f"{cfg.get_api_doc_path()}/template.yaml")
+swagger = Swagger(app, template_file=f"src/{cfg.get_api_doc_path()}/template.yaml")
 base_path: str = swagger.template["basePath"]
 
 

diff --git a/src/config.yaml → config.yaml b/src/config.yaml → config.yaml
diff --git a/tst/test_config.py b/tst/test_config.py
@@ -3,7 +3,7 @@
 
 from src.config import Config, CONFIG_FNAME
 
-config: Config = Config(path=f"src/{CONFIG_FNAME}")
+config: Config = Config(path=CONFIG_FNAME)
 
 
 class TestConfig: