https://github.com/MGough/flask-microservice-sqlalchemy-marshmallow

A starter flask microservice using the application factory pattern with SQLAlchemy, Marshmallow, and Dynaconf
https://github.com/MGough/flask-microservice-sqlalchemy-marshmallow

dynaconf flask marshmallow python3 sqlalchemy starter-project

Last synced: about 2 months ago
JSON representation

A starter flask microservice using the application factory pattern with SQLAlchemy, Marshmallow, and Dynaconf

• Host: GitHub
• URL: https://github.com/MGough/flask-microservice-sqlalchemy-marshmallow
• Owner: MGough
• License: mit
• Created: 2020-04-26T14:36:01.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-05-01T21:39:30.000Z (over 1 year ago)
• Last Synced: 2024-05-28T04:13:22.882Z (4 months ago)
• Topics: dynaconf, flask, marshmallow, python3, sqlalchemy, starter-project
• Language: Python
• Homepage:
• Size: 24.4 KB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - MGough/flask-microservice-sqlalchemy-marshmallow - A starter flask microservice using the application factory pattern with SQLAlchemy, Marshmallow, and Dynaconf (Python)

README

        
# flask-microservice-sqlalchemy-marshmallow

Quite a mouthful. This is a starter project for a flask microservice.

It uses SQLAlchemy to interact with a database, and Marshmallow for

serialization of objects.

The flask app itself is written using the application factory pattern,

to allow simple integration with WSGI servers such as Gunicorn.

## Application Configuration

Dynaconf has been used for simple configuration, a `settings.yml` file

is provided for development purposes and to help document the

configurable values. However dynaconf allows us to set these values as

environment variables instead which is usually preferable (see

[The 12 Factor app](https://12factor.net))

Flask config values can be set here, as well as our own custom

configuration values. See the [dynaconf documentation](https://dynaconf.readthedocs.io/en/latest/)

## Setting up your environment

As per the Dockerfile, this project is using Python 3.8 (disclaimer: this will inevitably fall out of date,

double check the dockerfile) so you'll need a Python 3.8 environment.

To ensure code quality is maintained, and to ensure your PR pipeline passes you will need to set up pre-commit.

```shell script

pip install -r requirements-dev.txt

```

The first time you do this you'll also need to run: `pre-commit install`. This will set up the autoformatting hooks.

For running the application locally (i.e. not in a docker container) you'll need to run `pip install -r requirements.txt`

## Running for development (debugging)

`development_wsgi.py` is provided to simplify running of the application.

`flask run` with the appropriate arguments could also be used, but the

`development_wsgi` file makes it simple to start the debugger in PyCharm

community edition, which I why I've included it.

## Running tests

Assuming your development environment is set up, it's as simple as running `tox`.

To run the integration tests you'll need docker installed & running, as well as

a working internet connection (to pull docker images).