{"id":14065415,"url":"https://github.com/MGough/flask-microservice-sqlalchemy-marshmallow","last_synced_at":"2025-07-29T20:32:43.679Z","repository":{"id":80109332,"uuid":"259052665","full_name":"MGough/flask-microservice-sqlalchemy-marshmallow","owner":"MGough","description":"A starter flask microservice using the application factory pattern with SQLAlchemy, Marshmallow, and Dynaconf","archived":false,"fork":false,"pushed_at":"2023-05-01T21:39:30.000Z","size":25,"stargazers_count":6,"open_issues_count":11,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-13T07:08:46.946Z","etag":null,"topics":["dynaconf","flask","marshmallow","python3","sqlalchemy","starter-project"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MGough.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-04-26T14:36:01.000Z","updated_at":"2023-11-12T14:50:56.000Z","dependencies_parsed_at":"2024-05-28T00:30:11.399Z","dependency_job_id":"188e09c4-6925-431d-8373-b2463268575a","html_url":"https://github.com/MGough/flask-microservice-sqlalchemy-marshmallow","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MGough%2Fflask-microservice-sqlalchemy-marshmallow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MGough%2Fflask-microservice-sqlalchemy-marshmallow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MGough%2Fflask-microservice-sqlalchemy-marshmallow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MGough%2Fflask-microservice-sqlalchemy-marshmallow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MGough","download_url":"https://codeload.github.com/MGough/flask-microservice-sqlalchemy-marshmallow/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228046152,"owners_count":17861101,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dynaconf","flask","marshmallow","python3","sqlalchemy","starter-project"],"created_at":"2024-08-13T07:04:28.810Z","updated_at":"2024-12-04T04:31:08.205Z","avatar_url":"https://github.com/MGough.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# flask-microservice-sqlalchemy-marshmallow\r\nQuite a mouthful. This is a starter project for a flask microservice.\r\nIt uses SQLAlchemy to interact with a database, and Marshmallow for\r\nserialization of objects.\r\n\r\nThe flask app itself is written using the application factory pattern,\r\nto allow simple integration with WSGI servers such as Gunicorn.\r\n\r\n## Application Configuration\r\nDynaconf has been used for simple configuration, a `settings.yml` file\r\nis provided for development purposes and to help document the\r\nconfigurable values. However dynaconf allows us to set these values as\r\nenvironment variables instead which is usually preferable (see\r\n[The 12 Factor app](https://12factor.net))\r\n\r\nFlask config values can be set here, as well as our own custom\r\nconfiguration values. See the [dynaconf documentation](https://dynaconf.readthedocs.io/en/latest/)\r\n\r\n## Setting up your environment\r\nAs per the Dockerfile, this project is using Python 3.8 (disclaimer: this will inevitably fall out of date,\r\ndouble check the dockerfile) so you'll need a Python 3.8 environment.\r\n\r\nTo ensure code quality is maintained, and to ensure your PR pipeline passes you will need to set up pre-commit.\r\n```shell script\r\npip install -r requirements-dev.txt\r\n```\r\n\r\nThe first time you do this you'll also need to run: `pre-commit install`. This will set up the autoformatting hooks.\r\n\r\nFor running the application locally (i.e. not in a docker container) you'll need to run `pip install -r requirements.txt`\r\n\r\n## Running for development (debugging)\r\n`development_wsgi.py` is provided to simplify running of the application.\r\n`flask run` with the appropriate arguments could also be used, but the\r\n`development_wsgi` file makes it simple to start the debugger in PyCharm\r\ncommunity edition, which I why I've included it.\r\n\r\n## Running tests\r\nAssuming your development environment is set up, it's as simple as running `tox`.\r\nTo run the integration tests you'll need docker installed \u0026 running, as well as\r\na working internet connection (to pull docker images).\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMGough%2Fflask-microservice-sqlalchemy-marshmallow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FMGough%2Fflask-microservice-sqlalchemy-marshmallow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMGough%2Fflask-microservice-sqlalchemy-marshmallow/lists"}