move mariadb to extras

Author: Puyodead1

README.md

@@ -4,28 +4,31 @@ Widevine Utility Website and Remote Widevine Device API.
 
 # Setup
 
-- Install Python Poetry: https://python-poetry.org/docs/master/#installation
-- Install depdencies: `poetry install`
-- Copy `.env.example` to `.env`.(#environment-variables)
-- Copy `getwvkeys/config.py.example` to `getwvkeys/config.py`
-- Edit `config.py` and `.env`
-- Run database migrations. see [Database Migrations](#database-migrations)
-- See [Deploy](#deploy)
+-   Install Python Poetry: https://python-poetry.org/docs/master/#installation
+-   Install Dependencies:
+    -   For MySQL: `poetry install -E mysql`
+    -   For MariaDB: `poetry install -E mariadb`
+-   Copy `getwvkeys/config.toml.example` to `getwvkeys/config.toml` (or the appropriate name for the environment)
+-   Edit `config.toml`
+    -   For a MySQL Database, use the prefix `mysql+mariadbconnector`
+    -   For a MariaDB Database, use the prefix `mariadb+mariadbconnector`
+-   Run database migrations. see [Database Migrations](#database-migrations)
+-   See [Deploy](#deploy)
 
 # Local Development
 
 For local development testing, you will need to disable the HTTPS requirement on the OAuth Callback URLs
 with the environment variable `OAUTHLIB_INSECURE_TRANSPORT=1` or you will get the error `InsecureTransportError`.
 
-- For Unix: `export OAUTHLIB_INSECURE_TRANSPORT=1`
-- Windows (CMD): `set OAUTHLIB_INSECURE_TRANSPORT=1`
-- Windows (Powershell): `$env:OAUTHLIB_INSECURE_TRANSPORT=1`
+-   For Unix: `export OAUTHLIB_INSECURE_TRANSPORT=1`
+-   Windows (CMD): `set OAUTHLIB_INSECURE_TRANSPORT=1`
+-   Windows (Powershell): `$env:OAUTHLIB_INSECURE_TRANSPORT=1`
 
 You should also enable development mode with the `DEVELOPMENT` environment variable.
 
-- For Unix: `export DEVELOPMENT=1`
-- Windows (CMD): `set DEVELOPMENT=1`
-- Windows (Powershell): `$env:DEVELOPMENT=1`
+-   For Unix: `export DEVELOPMENT=1`
+-   Windows (CMD): `set DEVELOPMENT=1`
+-   Windows (Powershell): `$env:DEVELOPMENT=1`
 
 For local development, you can use the built-in flask server with `poetry run serve`.
 
@@ -35,23 +38,23 @@ For local development, you can use the built-in flask server with `poetry run se
 
 # Environment Variables
 
-- `OAUTHLIB_INSECURE_TRANSPORT`: disable ssl for oauth
-- `DEVELOPMENT`: Development mode, increased logging and reads environment variables from `.env.dev`
-- `STAGING`: Staging mode, reads environment variables from `.env.staging`
+-   `OAUTHLIB_INSECURE_TRANSPORT`: Disable SSL requirement for OAuth2
+-   `DEVELOPMENT`: Development mode, increased logging and loads configuration from `config.dev.toml`
+-   `STAGING`: Staging mode, loads configuration from `config.staging.toml`
 
 # Deploy
 
 Gunicorn is the recommended to run the server in production.
 
 Example command to run on port 8081 listening on all interfaces:
 
-- `poetry run gunicorn -w 1 -b 0.0.0.0:8081 getwvkeys.main:app`
+-   `poetry run gunicorn -w 1 -b 0.0.0.0:8081 getwvkeys.main:app`
 
 _never use more than 1 worker, getwvkeys does not currently support that and you will encounter issues with sessions._
 
 # Other Info
 
-- Redis is used as a pub-sub system for communication with the Discord Bot. If you don't plan to use the bot, you don't need to setup redis and can comment it out in the `.env` file: `#REDIS_URI=redis://localhost:6379/0`
-- GetWVKeys uses dynamic injection for scripts, this means that when a user downloads a script and is logged in, the server injects certain values by replacing strings such as their API key. Available placeholders are:
-  - `__getwvkeys_api_key__`: Authenticated users api key
-  - `__getwvkeys_api_url__`: The instances API URL, this is used for staging and production mainly but can also be used for self hosted instances
+-   Redis is used as a pub-sub system for communication with the Discord Bot. If you don't plan to use the bot, you don't need to setup redis and can comment it out in the `.env` file: `#REDIS_URI=redis://localhost:6379/0`
+-   GetWVKeys uses dynamic injection for scripts, this means that when a user downloads a script and is logged in, the server injects certain values by replacing strings such as their API key. Available placeholders are:
+    -   `__getwvkeys_api_key__`: Authenticated users api key
+    -   `__getwvkeys_api_url__`: The instances API URL, this is used for staging and production mainly but can also be used for self hosted instances

pyproject.toml

@@ -4,7 +4,7 @@ version = "0.1.1"
 description = "Widevine License Proxy"
 authors = [
     "notaghost <[email protected]>",
-    "Puyodead1 <[email protected]>"
+    "Puyodead1 <[email protected]>",
 ]
 license = "AGPL-3.0-only"
 
@@ -25,7 +25,6 @@ Flask-SQLAlchemy = ">=3.1.1"
 gunicorn = "^20.1.0"
 redis = "^4.4.4"
 validators = "^0.20.0"
-mariadb = "^1.1.10"
 sqlalchemy = ">=2.0.16"
 waitress = "^3.0.0"
 flask-caching = "^2.3.0"
@@ -45,3 +44,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.isort]
 profile = "black"
+
+[tool.poetry.extras]
+mysql = ["mysql-connector-python"]
+mariadb = ["mariadb"]