Initial commit

Author: Rehket

.gitignore

@@ -0,0 +1,2 @@
+.idea*
+venv*

ReadMe.md

@@ -0,0 +1,29 @@
+# FastAPI Template Repo
+## Based on the backend in [@tiangolo's](https://github.com/tiangolo) [full-stack-fastapi-postgresql](https://github.com/tiangolo/full-stack-fastapi-postgresql)
+
+### Setup
+- Create and activate a virtual environment
+- Setup the env.ps1 script with desired variables. 
+- In the virtual environment:
+    - run the ```env.ps1``` script to set the environment variables. 
+    - install the packages included in the ```req.txt```
+    - run ```python ./bootstrap.py```
+    
+    If you want the alembic generated model use: 
+    - run ```alembic revision --autogenerate -m "Setup initial user table"```  
+    - run ```alembic upgrade head```
+    - run ```python ./initial_data.py```
+    
+    Lastly...
+    - run ```uvicorn app.main:app --reload``` to start the application 
+
+### Usage
+- Once the application is running, by 
+going to ```localhost:8000/docs``` or what you configured in the env.ps1, you will be able to login and tryout the endpoints. 
+
+
+### Change Log:
+#### 1-Aug-2019
+Changing this repo from a repo used for demoing an issue to a template for making an API service using postgres and FastAPI.
+
+- Adding an archive with the old readme detailing the error. 

alembic.ini

@@ -0,0 +1,71 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = alembic
+
+# template used to generate migration files
+# file_template = %%(rev)s_%%(slug)s
+
+# timezone to use when rendering the date
+# within the migration file as well as the filename.
+# string value is passed to dateutil.tz.gettz()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+#truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; this defaults
+# to alembic/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path
+# version_locations = %(here)s/bar %(here)s/bat alembic/versions
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+# 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

alembic/README

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

alembic/env.py

@@ -0,0 +1,167 @@
+from __future__ import with_statement
+
+import os
+
+from alembic import context
+from sqlalchemy import (
+    engine_from_config,
+    pool,
+    MetaData,
+    Table,
+    ForeignKeyConstraint,
+    Index,
+)
+from logging.config import fileConfig
+from app.core.config import POSTGRES_SCHEMA, PUBLIC_TABLES, SCHEMA_QUERY
+
+# 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)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+# target_metadata = None
+
+from app.db.base import Base  # noqa
+
+target_metadata = Base.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 get_url():
+    user = os.getenv("POSTGRES_USER", "postgres")
+    password = os.getenv("POSTGRES_PASSWORD", "")
+    server = os.getenv("POSTGRES_SERVER", "db")
+    db = os.getenv("POSTGRES_DB", "app")
+    port = os.getenv("POSTGRES_PORT", 5432)
+    return f"postgresql://{user}:{password}@{server}:{port}/{db}"
+
+
+def include_schemas(names):
+    # produce an include object function that filters on the given schemas
+    def include_object(object, name, type_, reflected, compare_to):
+        if type_ == "table":
+            return object.schema in names
+        return True
+
+    return include_object
+
+
+def lookup_correct_schema(name):
+    if name in PUBLIC_TABLES:
+        return "public"
+    else:
+        return POSTGRES_SCHEMA
+
+
+def _get_table_key(name, schema):
+    if schema is None:
+        return name
+    else:
+        return schema + "." + name
+
+
+def tometadata(table, metadata, schema):
+    key = _get_table_key(table.name, schema)
+    if key in metadata.tables:
+        return metadata.tables[key]
+
+    args = []
+    for c in table.columns:
+        args.append(c.copy(schema=schema))
+    new_table = Table(table.name, metadata, schema=schema, *args, **table.kwargs)
+    for c in table.constraints:
+        if isinstance(c, ForeignKeyConstraint):
+            constraint_schema = lookup_correct_schema(c.elements[0].column.table.name)
+        else:
+            constraint_schema = schema
+        new_table.append_constraint(
+            c.copy(schema=constraint_schema, target_table=new_table)
+        )
+
+    for index in table.indexes:
+        # skip indexes that would be generated
+        # by the 'index' flag on Column
+        if len(index.columns) == 1 and list(index.columns)[0].index:
+            continue
+        Index(
+            index.name,
+            unique=index.unique,
+            *[new_table.c[col] for col in index.columns.keys()],
+            **index.kwargs,
+        )
+    return table._schema_item_copy(new_table)
+
+
+meta_schemax = MetaData()
+for table in target_metadata.tables.values():
+    tometadata(table, meta_schemax, lookup_correct_schema(table.name))
+target_metadata = meta_schemax
+
+
+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 = get_url()
+    context.configure(
+        url=url,
+        target_metadata=target_metadata,
+        literal_binds=True,
+        compare_type=True,
+        version_table_schema="schema_case",
+    )
+
+    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.
+
+    """
+    configuration = config.get_section(config.config_ini_section)
+    configuration["sqlalchemy.url"] = get_url()
+    connectable = engine_from_config(
+        configuration, prefix="sqlalchemy.", poolclass=pool.NullPool
+    )
+
+    with connectable.connect() as connection:
+        context.configure(
+            connection=connection,
+            target_metadata=target_metadata,
+            compare_type=True,
+            include_schemas=True,  # schemas,
+            version_table_schema=POSTGRES_SCHEMA,
+            include_object=include_schemas([None, POSTGRES_SCHEMA])
+        )
+        with context.begin_transaction():
+            context.execute(f"SET search_path TO {POSTGRES_SCHEMA}")
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

alembic/script.py.mako

@@ -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"}

alembic/versions/.keep

@@ -0,0 +1,43 @@
+"""My Test
+
+Revision ID: 0dd362c5b5bf
+Revises: 
+Create Date: 2019-07-31 10:20:33.478780
+
+"""
+from alembic import op
+import sqlalchemy as sa
+
+
+# revision identifiers, used by Alembic.
+revision = '0dd362c5b5bf'
+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('full_name', sa.String(), nullable=True),
+    sa.Column('email', sa.String(), nullable=True),
+    sa.Column('hashed_password', sa.String(), nullable=True),
+    sa.Column('is_active', sa.Boolean(), nullable=True),
+    sa.Column('is_superuser', sa.Boolean(), nullable=True),
+    sa.PrimaryKeyConstraint('id'),
+    schema='schema_case'
+    )
+    op.create_index(op.f('ix_schema_case_user_email'), 'user', ['email'], unique=True, schema='schema_case')
+    op.create_index(op.f('ix_schema_case_user_full_name'), 'user', ['full_name'], unique=False, schema='schema_case')
+    op.create_index(op.f('ix_schema_case_user_id'), 'user', ['id'], unique=False, schema='schema_case')
+    # ### end Alembic commands ###
+
+
+def downgrade():
+    # ### commands auto generated by Alembic - please adjust! ###
+    op.drop_index(op.f('ix_schema_case_user_id'), table_name='user', schema='schema_case')
+    op.drop_index(op.f('ix_schema_case_user_full_name'), table_name='user', schema='schema_case')
+    op.drop_index(op.f('ix_schema_case_user_email'), table_name='user', schema='schema_case')
+    op.drop_table('user', schema='schema_case')
+    # ### end Alembic commands ###

alembic/versions/0dd362c5b5bf_my_test.py

@@ -0,0 +1 @@
+from . import api, core, crud, db, db_models, models

app/__init__.py

@@ -0,0 +1,9 @@
+from fastapi import APIRouter
+
+from app.api.api_v1.endpoints import health, login, users
+
+api_router = APIRouter()
+api_router.include_router(login.router, tags=["login"])
+api_router.include_router(health.router, prefix="/health", tags=["health"])
+api_router.include_router(users.router, prefix="/users", tags=["users"])
+

app/api/__init__.py

@@ -0,0 +1,12 @@
+from fastapi import APIRouter
+
+
+router = APIRouter()
+
+
+@router.get("/")
+def get_health():
+    """
+    Retrieve items.
+    """
+    return {"health": "ok"}