Merge branch '107-add-required-packages-to-connect-to-mysql-databae' …

…into 'main'

Resolve "Add required packages to connect to MySQL databae"

Closes #107

See merge request pub/terrareg!77

README.md

@@ -211,6 +211,9 @@ Default: `True`
 URL for database.
 Defaults to local sqlite database.
 
+To setup SQLite datbase, use `sqlite:///<path to sqlite DB>`
+
+To setup MySQL, use `mysql+mysqlconnector://<user>:<password>@<host>[:<port>]/<database>`
 
 Default: `sqlite:///modules.db`
 
@@ -418,6 +421,7 @@ There are common attributes that can be added to each of variable objects, which
 
 ### v1.1.0
 
+ * Add MySQL connector and document URL format to connect to MySQL
  * Provide ability to pass SSH private key through environment variable
 
 ### v1.0.3

requirements.txt

@@ -23,3 +23,4 @@ SQLAlchemy==1.4.35
 Werkzeug==2.0.0
 zipp==3.8.0
 alembic==1.7.7
+mysql-connector-python==8.0.29

terrareg/config.py

@@ -12,6 +12,10 @@ def DATABASE_URL(self):
         """
         URL for database.
         Defaults to local sqlite database.
+
+        To setup SQLite datbase, use `sqlite:///<path to sqlite DB>`
+
+        To setup MySQL, use `mysql+mysqlconnector://<user>:<password>@<host>[:<port>]/<database>`
         """
         return os.environ.get('DATABASE_URL', 'sqlite:///modules.db')