Initial commit

Author: Matthew R. Laue

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+exclude = alembic

.gitignore

@@ -0,0 +1,8 @@
+.env
+.idea
+*.egg-info
+build
+dist
+*.db
+venv
+__pycache__

Makefile

@@ -0,0 +1,16 @@
+all: flake8 test
+.PHONY: all
+
+flake8:
+	flake8 fastapi_sqlalchemy_example tests
+.PHONY: flake8
+
+test:
+	pytest -xv tests
+.PHONY: test
+
+requirements.txt:
+	virtualenv -p python3 venv
+	venv/bin/pip3 install git+https://github.com/zuarbase/fastapi-sqlalchemy#egg=fastapi-sqlalchemy[dev,prod]
+	venv/bin/pip3 install -e .[dev,prod]
+	venv/bin/pip3 freeze | egrep -v "fastapi_sqlalchemy_example|pkg-resources" > $@

fastapi_sqlalchemy_example/__init__.py

@@ -0,0 +1 @@
+from . import endpoints  # noqa

fastapi_sqlalchemy_example/alembic.ini

@@ -0,0 +1,74 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = /home/matt/Projects/zuar/fastapi_sqlalchemy_example/fastapi_sqlalchemy_example/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
+
+sqlalchemy.url = sqlite:////home/matt/Projects/zuar/fastapi_sqlalchemy_example/fastapi_sqlalchemy_example.db
+version_table = migrations
+
+# 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

fastapi_sqlalchemy_example/alembic/README

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

fastapi_sqlalchemy_example/alembic/env.py

@@ -0,0 +1,75 @@
+
+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)
+
+# add your model's MetaData object here
+# for 'autogenerate' support
+# from myapp import mymodel
+# target_metadata = mymodel.Base.metadata
+target_metadata = None
+
+# 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.
+
+    """
+    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
+        )
+
+        with context.begin_transaction():
+            context.run_migrations()
+
+
+if context.is_offline_mode():
+    run_migrations_offline()
+else:
+    run_migrations_online()

fastapi_sqlalchemy_example/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"}

fastapi_sqlalchemy_example/endpoints/__init__.py

@@ -0,0 +1,6 @@
+# flake8: noqa
+from .config import get_config
+from .login import login_get, login_post
+from .logout import login_post
+from .register import register_get, register_post
+from .confirm import confirm_get

fastapi_sqlalchemy_example/endpoints/config.py

@@ -0,0 +1,13 @@
+from fastapi_sqlalchemy.auth import authenticated
+from fastapi_sqlalchemy_example.main import app
+
+from starlette.requests import Request
+
+
+@app.get('/api/config')
+@authenticated()
+async def get_config(request: Request) -> dict:
+    return {
+        "user": request.user.as_dict(),
+        "scopes": request.auth.scopes,
+    }

fastapi_sqlalchemy_example/endpoints/confirm.py

@@ -0,0 +1,21 @@
+import fastapi
+from starlette.requests import Request
+
+from fastapi_sqlalchemy.endpoints import ConfirmEndpoint
+
+from fastapi_sqlalchemy_example import settings, models
+from fastapi_sqlalchemy_example.main import app
+
+ENDPOINT = ConfirmEndpoint(
+    user_cls=models.User,
+    secret=str(settings.SECRET),
+)
+
+
+@app.get('/confirm/{token}')
+async def confirm_get(
+        request: Request,
+        token: str
+):
+    """ confirmation of email link """
+    return await ENDPOINT.on_get(request.state.session, token)

fastapi_sqlalchemy_example/endpoints/login.py

@@ -0,0 +1,27 @@
+import fastapi
+from starlette.requests import Request
+
+from fastapi_sqlalchemy.endpoints import LoginEndpoint
+
+from fastapi_sqlalchemy_example import settings, models
+from fastapi_sqlalchemy_example.main import app
+
+ENDPOINT = LoginEndpoint(models.User, secret=str(settings.SECRET), secure=False)
+
+
+@app.get('/login')
+async def login_get():
+    """ Login form """
+    return await ENDPOINT.on_get()
+
+
+@app.post('/login')
+async def login_post(
+        request: Request,
+        username: str = fastapi.Form(...),
+        password: str = fastapi.Form(...),
+):
+    """ Login handler """
+    return await ENDPOINT.on_post(
+        request.state.session, username, password
+    )

fastapi_sqlalchemy_example/endpoints/logout.py

@@ -0,0 +1,12 @@
+from fastapi_sqlalchemy.endpoints import LogoutEndpoint
+
+from fastapi_sqlalchemy_example.main import app
+
+ENDPOINT = LogoutEndpoint()
+
+
+@app.post('/logout')
+async def login_post(
+):
+    """ Logout handler """
+    return await ENDPOINT.on_post()

fastapi_sqlalchemy_example/endpoints/register.py

@@ -0,0 +1,43 @@
+import fastapi
+from starlette.requests import Request
+
+from fastapi_sqlalchemy.endpoints import RegisterEndpoint
+
+from fastapi_sqlalchemy_example import settings, models
+from fastapi_sqlalchemy_example.main import app
+
+ENDPOINT = RegisterEndpoint(
+    user_cls=models.User,
+    sender=settings.EMAIL_SENDER,
+    secret=str(settings.SECRET),
+
+    email_server=settings.EMAIL_SERVER,
+    email_port=settings.EMAIL_PORT,
+    email_use_ssl=settings.EMAIL_USE_SSL,
+    email_use_tls=settings.EMAIL_USE_TLS,
+    email_login=settings.EMAIL_LOGIN,
+    email_password=settings.EMAIL_PASSWORD,
+)
+
+
+@app.get('/register')
+async def register_get():
+    """ registration form """
+    return await ENDPOINT.on_get()
+
+
+@app.post('/register')
+async def register_post(
+        request: Request,
+        username: str = fastapi.Form(...),
+        email: str = fastapi.Form(...),
+        password: str = fastapi.Form(...),
+        confirm_password: str = fastapi.Form(None),
+):
+    """ Login handler """
+    base_url = request.url.scheme + '://' + request.url.netloc
+    return await ENDPOINT.on_post(
+        base_url, request.state.session,
+        username=username, email=email,
+        password=password, confirm_password=confirm_password
+    )

fastapi_sqlalchemy_example/main.py

@@ -0,0 +1,37 @@
+""" application main """
+import logging
+
+from fastapi_sqlalchemy import FastAPI_SQLAlchemy, middleware, auth
+from fastapi_sqlalchemy_example import models
+
+from starlette.middleware.authentication import AuthenticationMiddleware
+from starlette.staticfiles import StaticFiles
+
+from . import settings
+
+
+logger = logging.getLogger(__name__)
+
+
+def make_app() -> FastAPI_SQLAlchemy:
+    """ Create an ASGI Application
+    """
+    logging.basicConfig()
+    logging.getLogger('fastapi_sqlalchemy').setLevel(logging.INFO)
+
+    myapp = FastAPI_SQLAlchemy(
+        str(settings.DATABASE_URL),
+        title='FastAPI-SQLAlchemy Example',
+        version='0.0.0'
+    )
+    myapp.add_middleware(
+        AuthenticationMiddleware,
+        backend=auth.PayloadAuthBackend(user_cls=models.User)
+    )
+    myapp.add_middleware(middleware.JwtMiddleware, secret=str(settings.SECRET))
+    myapp.add_middleware(middleware.SessionMiddleware)
+    return myapp
+
+
+app = make_app()
+app.router.default = StaticFiles(directory='static', html=True)

fastapi_sqlalchemy_example/models/__init__.py

@@ -0,0 +1 @@
+from .users import User  # noqa

fastapi_sqlalchemy_example/models/users.py

@@ -0,0 +1,6 @@
+from fastapi_sqlalchemy import models
+from fastapi_sqlalchemy.models import mixins
+
+
+class User(models.User, mixins.ConfirmationMixin):
+    pass