db: Handle mysql database.

Author: shanukun

README.md

@@ -27,9 +27,14 @@ Ziho is a prototype for a better online interface for Anki than [Anki Web](https
 Ziho allows you to create, study and easily share and clone decks, as well as edit them online. 
 
 The backend is built with **Flask**, and the [fsrs](https://github.com/open-spaced-repetition) algorithm is used for spaced repetition.
+Following were also used:
+- Bootstrap
+- SQLAlchemy
+- Docker
 
-<span><img src="https://shanukun.github.io/static/images/ziho/home.png"  width="30%"></span>
-<span><img src="https://shanukun.github.io/static/images/ziho/study-deck.png" width="25%"></span>
+
+<span><img src="https://shanukun.github.io/static/images/ziho/home.png"  width="40%"></span>
+<span><img src="https://shanukun.github.io/static/images/ziho/study-deck.png" width="35%"></span>
 
 You can find more screenshots [here](https://shanukun.github.io/ziho-ss/).
 
@@ -58,7 +63,30 @@ You can find more screenshots [here](https://shanukun.github.io/ziho-ss/).
     ./tools/setup
     ```
 3. **Set up your environment variables in a `.env` file: To run without debug mode, set `DEBUG_MODE=off`.** 
+    - Set following for using MySQL
+        - MYSQL_USER
+        - MYSQL_PASS
+        - MYSQL_HOST
+        - MYSQL_PORT
+        - MYSQL_DB
 4. **Start the webapp:**
     ```bash
     ./tools/run-ziho
     ```
+
+## Contributing
+
+1. Follow the code style. Run the following to test the format.
+    ```bash
+    ./tools/test_lint
+    ```
+2. Format the code using:
+    ```bash
+    ./tools/lint_and_format
+    ```
+3. Make sure to add the tests for new routes
+    ```bash
+    pytest ./tests
+    ```
+
+ 

config.py

@@ -1,4 +1,5 @@
 import os
+import sys
 from pathlib import Path
 
 from dotenv import load_dotenv
@@ -7,17 +8,24 @@
 load_dotenv()
 
 
-DATABASE = "sqlite:///" + os.path.join(basedir, "app.db")
+def z_env(env_var: str) -> str | None:
+    var_val = os.environ.get(env_var, None)
+    return var_val
+
+
+DATABASE_URL = "sqlite:///" + os.path.join(basedir, "app.db")
 if os.environ.get("DATABASE") == "mysql":
-    pass
+    DATABASE_URL = f"mysql+pymysql://{z_env('MYSQL_USER')}:{z_env('MYSQL_PASS')}@{z_env('MYSQL_HOST')}:{z_env('MYSQL_PORT')}/{z_env('MYSQL_DB')}"
 
 
 class Config:
-    SECRET_KEY = os.environ.get("SECRET_KEY") or "hardcoded-string"
+    DATABASE = z_env("DATABASE")
+    SECRET_KEY = z_env("SECRET_KEY") or "hardcoded-string"
 
     # sqlalchemy
-    SQLALCHEMY_DATABASE_URI = os.environ.get("DATABASE_URL") or DATABASE
+    SQLALCHEMY_DATABASE_URI = DATABASE_URL
     SQLALCHEMY_TRACK_MODIFICATIONS = False
+
     UPLOAD_FOLDER = Path("ziho_uploads")
     UPLOAD_PATH = Path(basedir) / "ziho" / UPLOAD_FOLDER
 

tools/setup

@@ -32,4 +32,3 @@ curl -fLO --retry 3 "https://github.com/sass/dart-sass/releases/download/$versio
 tar -xf "$tarball" --strip-components=1 -C "$CWD/bin/sass"
 
 "$CWD"/bin/sass/sass --no-source-map --style compressed "$CWD"/ziho/static/scss/main.scss "$CWD"/ziho/static/css/main.css
-

ziho/__init__.py

@@ -28,13 +28,14 @@ def create_app(config_class=Config):
 
     db.init_app(app)
 
-    with app.app_context():
-
-        @event.listens_for(db.engine, "connect")
-        def set_sqlite_pragma(dbapi_connection, connection_record):
-            cursor = dbapi_connection.cursor()
-            cursor.execute("PRAGMA foreign_keys=ON")
-            cursor.close()
+    if config_class.DATABASE != "mysql":
+        with app.app_context():
+
+            @event.listens_for(db.engine, "connect")
+            def set_sqlite_pragma(dbapi_connection, connection_record):
+                cursor = dbapi_connection.cursor()
+                cursor.execute("PRAGMA foreign_keys=ON")
+                cursor.close()
 
     migrate.init_app(app, db, render_as_batch=True)
     login_manager.init_app(app)