https://github.com/treebohotels/flask-wired
Flask-Wired is an opinionated composable wrapper framework for Flask
https://github.com/treebohotels/flask-wired
flask
Last synced: about 1 month ago
JSON representation
Flask-Wired is an opinionated composable wrapper framework for Flask
- Host: GitHub
- URL: https://github.com/treebohotels/flask-wired
- Owner: treebohotels
- License: mit
- Created: 2018-07-17T11:24:45.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-09-15T11:12:29.000Z (almost 8 years ago)
- Last Synced: 2025-09-18T03:37:11.527Z (9 months ago)
- Topics: flask
- Language: Python
- Homepage:
- Size: 27.3 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.md
Awesome Lists containing this project
README
===========
Flask-Wired
===========
Flask-Wired is an opinionated composable supporting framework for Flask.
.. image:: https://travis-ci.org/treebohotels/Flask-Wired.svg?branch=master
Quick summary
~~~~~~~~~~~~~
Flask-Wired is designed to be used Flask to simplify initial bootstrap wiring for Micro Services by
1. Taking a standardized way of wiring the components like DB connections, transactions, serializers, service discovery, log aggregation etc.
2. Provide a place for the boilerplate code to be maintained in a standardized way & upgrade seamlessly
3. Reduce the time taken for bootstrapping by simplifying the service template. Ex: defaults for app.py, manage.py will be provided by Flask-Wired.
Initial version supports the following:
1. DB connection
2. marshmallow as default serializer
3. Flask blueprints registration
4. Structured Logging
5. Request Id generator
How do I install?
~~~~~~~~~~~~~~~~~
.. code-block:: text
pip install Flask-Wired
Configuration
~~~~~~~~~~~~~
1. configure the extensions in settings.py as usual.
2. follow the documentation for additional keys supported by Flask-Wired.
3. Keep Flask-Wired version up to date with latest & greatest.
.. note:: Do not add a direct dependency to Flask in your project directly.
Dependencies
~~~~~~~~~~~~
1. Flask
2. Flask-Script
3. Flask-Migrate
Deployment instructions
~~~~~~~~~~~~~~~~~~~~~~~
Package & Deploy your code the same way as with Flask.
Contribution guidelines
~~~~~~~~~~~~~~~~~~~~~~~
* Writing tests - TBD
* Code review - TBD
* Other guidelines - TBD
Who do I talk to?
~~~~~~~~~~~~~~~~~
* Repo owner or admin
* Other community or team contact