Extract DAL from time_tracker_api #50

Author: EliuX

.env.template

@@ -1,5 +1,8 @@
-# Package where the app is located
+# API
+## Package where the app is located
 export FLASK_APP=time_tracker_api
 
-# The database connection URI. Check out the README.md for more details
+
+# Common attributes
+## The database connection URI. Check out the README.md for more details
 DATABASE_URI=mssql+pyodbc://<user>:<password>@time-tracker-srv.database.windows.net/<database>?driver\=ODBC Driver 17 for SQL Server

Dockerfile

@@ -27,4 +27,4 @@ ENV FLASK_APP time_tracker_api
 
 EXPOSE 5000
 
-CMD ["gunicorn", "-b 0.0.0.0:5000", "run:app"]
+CMD ["gunicorn", "-b 0.0.0.0:5000", "api:app"]

README.md

@@ -1,6 +1,6 @@
 # time-tracker-api
 
-The API of the TSheets killer app.
+This is the mono-repository for the backend services and common codebase
 
 ## Getting started
 Follow the following instructions to get the project ready to use ASAP.
@@ -30,10 +30,16 @@ automatically [pip](https://pip.pypa.io/en/stable/) as well.
     
 - Install the requirements:
     ```
-    python3 -m pip install -r requirements/<stage>.txt
+    python3 -m pip install -r requirements/<app>/<stage>.txt
     ```
     
-    The `stage` can be `dev` or `prod`. 
+    Where <app> is one of the executable app namespace, e.g. `time_tracker_api`.
+    The `stage` can be 
+    
+    * `dev`: Used for working locally
+    * `prod`: For anything deployed
+    
+    
     Remember to do it with Python 3.
     
     

run.py renamed to api.py

@@ -0,0 +1,12 @@
+# requirements/sql_db_serverless.txt
+
+# For SQL database serverless (MS SQL)
+
+
+# SQL Server driver
+pyodbc==4.0.30
+
+# ORM
+SQLAlchemy==1.3.15
+SQLAlchemy-Utils==0.36.3
+flask_sqlalchemy==2.4.1

tests/activities/__init__.py renamed to commons/__init__.py

@@ -1,5 +1,6 @@
-# requirements/dev.txt
+# requirements/time_tracker_api/dev.txt
 
+# Include the prod resources
 -r prod.txt
 
 # For development