Merge pull request #1 from enaguero/main

Remove mysql description and dependencies and add postgres documentation

Author: alesanchezr

Pipfile

@@ -13,10 +13,8 @@ flask-migrate = "*"
 flask-swagger = "*"
 psycopg2-binary = "*"
 python-dotenv = "*"
-mysql-connector-python = "*"
 flask-cors = "*"
 gunicorn = "*"
-mysqlclient = "*"
 cloudinary = "*"
 flask-admin = "*"
 

Pipfile.lock

@@ -1,29 +1,51 @@
-# Creating and/or Accessing the MySQL Database
+# Database configuration
 
-1. Log in to mysql terminal:
+In this boilerplate, you can use either postgres or sqlite as database engine. Verify your .env file to specify which one you would like to use.
+You can use the env var `DATABASE_URL` for this purpose.
+
+# Creating and/or Accessing the Postgres Database
+
+1. Log in to postgres terminal:
 ```sh
-$ mysql
+$ psql
 ```
-2. Once inside, check if you have the database already created:
+2. Once inside, list all the databases and check if you have the database already created:
 ```sql
-SHOW databases;
+\l
 ```
+Note: If you are using GitPod, check the file `docs/assets/reset_migrations.bash`. Basically, you are creating a database from scratch call `example`.
+
 3. If you don't see the example database create it by typing:
 ```sql
 CREATE DATABASE example;
 ```
 Note: Make sure to update the `DB_CONNECTION_STRING` on the `.env` file with the correct database name.
 
 3. If your database is already created, get inside of it by typing:
+
+*Command*
 ```sql
-USE example;
+\c example;
 ```
-4. Now you can type any SQL command you like, for example:
+
+*Result*
 ```sql
-SHOW TABLES;
+postgres=# \c example;
+You are now connected to database "example" as user "gitpod".
 ```
-Note: type `exit;` to quit.
+4. Now you could want to see all the tables availables:
+```sql
+\dt
+```
+
+5. Also you can execute, all the SQL queries you want. For example, assuming you have a `users` table:
+```
+select * from users;
+```
+
+Note: Type `exit` if you want to exit from the postgres terminal.
 
+More commands, you can check this [amazing summary](https://www.postgresqltutorial.com/postgresql-cheat-sheet/).
 
 # Querying data using Python and SQL Alchemy (SELECT)
 

docs/DATABASE.md

@@ -0,0 +1 @@
+Generic single-database configuration.

migrations/README

@@ -0,0 +1,45 @@
+# A generic, single database configuration.
+
+[alembic]
+# template used to generate migration files
+# file_template = %%(rev)s_%%(slug)s
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

migrations/alembic.ini

@@ -0,0 +1,96 @@
+from __future__ import with_statement
+
+import logging
+from logging.config import fileConfig
+
+from sqlalchemy import engine_from_config
+from sqlalchemy import pool
+
+from alembic import context
+
+# this is the Alembic Config object, which provides
+# access to the values within the .ini file in use.
+config = context.config
+
+# Interpret the config file for Python logging.
+# This line sets up loggers basically.
+fileConfig(config.config_file_name)
+logger = logging.getLogger('alembic.env')
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+from flask import current_app
+config.set_main_option(
+    'sqlalchemy.url',
+    str(current_app.extensions['migrate'].db.engine.url).replace('%', '%%'))
+target_metadata = current_app.extensions['migrate'].db.metadata
+
+# other values from the config, defined by the needs of env.py,
+# can be acquired:
+# my_important_option = config.get_main_option("my_important_option")
+# ... etc.
+
+
+def run_migrations_offline():
+    """Run migrations in 'offline' mode.
+
+    This configures the context with just a URL
+    and not an Engine, though an Engine is acceptable
+    here as well.  By skipping the Engine creation
+    we don't even need a DBAPI to be available.
+
+    Calls to context.execute() here emit the given string to the
+    script output.
+
+    """
+    url = config.get_main_option("sqlalchemy.url")
+    context.configure(
+        url=url, target_metadata=target_metadata, literal_binds=True
+    )
+
+    with context.begin_transaction():
+        context.run_migrations()
+
+
+def run_migrations_online():
+    """Run migrations in 'online' mode.
+
+    In this scenario we need to create an Engine
+    and associate a connection with the context.
+
+    """
+
+    # this callback is used to prevent an auto-migration from being generated
+    # when there are no changes to the schema
+    # reference: http://alembic.zzzcomputing.com/en/latest/cookbook.html
+    def process_revision_directives(context, revision, directives):
+        if getattr(config.cmd_opts, 'autogenerate', False):
+            script = directives[0]
+            if script.upgrade_ops.is_empty():
+                directives[:] = []
+                logger.info('No changes in schema detected.')
+
+    connectable = engine_from_config(
+        config.get_section(config.config_ini_section),
+        prefix='sqlalchemy.',
+        poolclass=pool.NullPool,
+    )
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection,
+            target_metadata=target_metadata,
+            process_revision_directives=process_revision_directives,
+            **current_app.extensions['migrate'].configure_args
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

migrations/env.py

@@ -0,0 +1,24 @@
+"""${message}
+
+Revision ID: ${up_revision}
+Revises: ${down_revision | comma,n}
+Create Date: ${create_date}
+
+"""
+from alembic import op
+import sqlalchemy as sa
+${imports if imports else ""}
+
+# revision identifiers, used by Alembic.
+revision = ${repr(up_revision)}
+down_revision = ${repr(down_revision)}
+branch_labels = ${repr(branch_labels)}
+depends_on = ${repr(depends_on)}
+
+
+def upgrade():
+    ${upgrades if upgrades else "pass"}
+
+
+def downgrade():
+    ${downgrades if downgrades else "pass"}

migrations/script.py.mako

@@ -0,0 +1,35 @@
+"""empty message
+
+Revision ID: 30fb1b056366
+Revises: 
+Create Date: 2021-02-10 00:20:37.009332
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '30fb1b056366'
+down_revision = None
+branch_labels = None
+depends_on = None
+
+
+def upgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.create_table('user',
+    sa.Column('id', sa.Integer(), nullable=False),
+    sa.Column('email', sa.String(length=120), nullable=False),
+    sa.Column('password', sa.String(length=80), nullable=False),
+    sa.Column('is_active', sa.Boolean(), nullable=False),
+    sa.PrimaryKeyConstraint('id'),
+    sa.UniqueConstraint('email')
+    )
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_table('user')
+    # ### end Alembic commands ###