Storm integration for Flask.
Project description
Flask-Storm
Flask-Storm is an extension for Flask that adds support for Canonical’s ORM Storm to your application. Flask-Storm automatically opens and closes database connections on demand when requests need them.
Example
Access to the database is done using the store application context local. Within an application context this variable holds a reference to a Storm Store instance. If no connection is opened it will automatically open one. When the application context is torn down, normally after the request has returned, the store is closed.
from flask_storm import store
from storm.locals import Int, Unicode
class User(object):
__storm_table__ = "users"
id = Int(primary=True)
name = Unicode()
@app.route("/")
def index():
# Get name of user with ID 1
return store.get(User, 1).name
Installation
pip install flask_storm[fancy]
This installs Flask-Storm with SQL highlighting and reformatting support. If you do not want this drop the fancy.
pip install flask_storm
Documentation
Documentation is available on https://runfalk.github.io/flask-storm
Development
# Setup environment
python3 -m venv --prompt=flask-storm .venv
source .venv/bin/activate
pip install --upgrade pip setuptools
pip install -e .[dev,fancy]
# Run test suite
pytest
# You can test all supported python versions in one go using tox
tox
# Build documentation
sphinx-build doc/ doc-build/
# Run auto formatter
black flask_storm/ tests/ setup.py
# Run linter
flake8 flask_storm/ tests/ setup.py
Changelog
Version are structured like the following: <major>.<minor>.<bugfix>. Unless explicitly stated, changes are made by Andreas Runfalk.
Version 1.0.0
Released on 23rd May 2021
Dropped support for Python 3.3
Dropped support for Python 3.4
Dropped support for Python 3.5
Updated documentation to work with newer Sphinx versions
Support upstream Storm 0.21 or newer (thank you Colin Watson)
Fixed broken placeholder replacement when using SQL statement printing in Python 3 (thank you Colin Watson)
Fixed problem where fancy would always be set to False regardless of the provided value when it was specified to a tracer.
Note that dropped Python versions may still work, but that’s accidental rather than intentional.
Version 0.2.0
Released on 8th October 2018
Added Python 3 support
Removed storm as a dependency since storm-legacy can be used as well
Version 0.1.2
Released on 14th June 2017
Fixed an issue with query logging in flask shell and PostgreSQL
Version 0.1.1
Released on 9th June 2017
Fixed issue with new versions of sqlparse by bumping its version requirement
Version 0.1.0
Released on 19 July 2016
Initial release
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for Flask_Storm-1.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aa6655c0d0479b6c559733a05b257f84073e5e6c8390f3f4646539d877dd4705 |
|
MD5 | e25f668f347fd0a7f9167e4378d73a32 |
|
BLAKE2b-256 | acbb0d4fa6e2432a2cf3087f2a4c91005fff0caf8f00465c5697dfdf545b1da4 |