The sls-flask from jetbridge

sls-flask's Introduction

Opinionated Serverless Flask

Comes with a lot of useful stuff ready to go.

Designed for serverless API development with PostgreSQL.

Features

Flask Smorest
- OpenAPI
- Swagger UI
- Redoc
Pytest using database subtransactions for test isolation
Pytest-FactoryBoy for generating sample data for seeding DB and tests.
Flake8 for linting
Mypy for type-checking
Black for formatting
AWS Lambda integration
- Serverless AWS
- AWS Aurora Serverless Postgres for on-demand Postgresql DB with a data-api query driver (optional).
- Load Flask config from AWS Secrets Manager
Flask-Migrate for DB migrations with alembic and Flask CLI
Poetry for dependency management

Quickstart:

Prerequisites:

curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python  # poetry
npm i -g serverless

Create Project:

npx sls install --url https://github.com/jetbridge/sls-flask --name myapp
cd myapp
make init  # install dependencies and initialize project, database

Useful Commands:

Python Virtual Environment:

poetry shell  # activate python virtual environment
poetry install  # install dependencies

Run Dev Server:

flask  # CLI commands
make run  # run flask dev server
sls wsgi serve  # run flask dev server under serverless

Database:

Using Postgresql.

createdb TEMPLATE  # create DB
flask db upgrade  # run migrations
flask seed  # populate with sample data
flask db migrate  # generate new migration
flask db  # more migration commands

Deploy:

make deploy-dev   # deploy to AWS and run migrations
make deploy-prd  # deploy to AWS and run migrations

API Documentation:

Once your flask dev server is running:

Database Driver

There are two options for database access: Aurora Data API or psycopg2/libpq.

Aurora Data API

Allows the application to query the database using AWS API calls. Does not require lambdas to be in a VPC, reducing the need for NAT gateways reducing cost and complexity. Has limitations and is somewhat beta.

Psycopg2

Standard Python PostgreSQL database driver. More powerful and efficient but requires enabling lambda VPC networking.

To Enable:

Uncomment VPC subnetIds config in serverless.yml
Uncomment - ${file(cloudformation/vpc/lambda.yml)} resource inclusion in serverless.yml

sls-flask's People

Contributors

Stargazers

Watchers

sls-flask's Issues

Dependency issue with Flask-Migrate.

New version of flask-migrate is not backward compatible I suppose and runs fail.

ImportError: cannot import name 'MigrateCommand' from 'flask_migrate'

Usage Tutorial with Example

I am very interested in this particular serverless stack (Serverless Framework + Flask + Aurora), but im strugling to start. If you could provide a tutorial with a concrete example it would be awsome.

API title must be specified either as "API_TITLE" app parameter or as "title" spec kwarg.

I'm getting this after creating a new app and running make init.

swagger UI send request to endpoint without stage and return 403

I managed to create and deploy an application to AWS via this sls-flask service, but the swagger generated doesn't work, after enable the developer tools on Chrome, I found click the execute on swagger, it sends the request to an endpoint with stage, for example:

After "sls deploy -s dev", the output will contain the endpoint which looks like:
https://xxxxxx.execute-api.ap-southeast-2.amazonaws.com/dev

And the swagger page can be accessed via:
https://xxxxxx.execute-api.ap-southeast-2.amazonaws.com/dev/api/swagger

But when click the "execute" for api "/api/auth/login", the request will be sent to:
https://xxxxxx.execute-api.ap-southeast-2.amazonaws.com/api/auth/login
and it return "403" {"message":"Forbidden"}

If the request is sent to https://xxxxxx.execute-api.ap-southeast-2.amazonaws.com/dev/api/auth/login, it works.

If I change the Blueprint "url_prefix="/api/auth" to "url_prefix="/dev/api/auth", it still doesn't work since now the correct endpoint should be https://xxxxxx.execute-api.ap-southeast-2.amazonaws.com/dev/dev/api/auth/login.

It looks like when sls-flask generate the swagger, it ignores the stage.

Recommend Projects

jetbridge / sls-flask Goto Github PK