1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
|
.. image:: https://raw.githubusercontent.com/pallets-eco/flask-session/main/docs/_static/icon/favicon-192x192.png
:alt: Flask-Session
:target: https://flask-session.readthedocs.io
:align: left
:width: 60px
==============
Flask-Session
==============
Flask-Session is an extension for Flask that adds support for server-side sessions to
your application.
.. image:: https://img.shields.io/github/actions/workflow/status/pallets-eco/flask-session/test.yaml?logo=github
:alt: GitHub Actions Workflow Status
:target: https://github.com/pallets-eco/flask-session/actions/workflows/test.yaml?query=workflow%3ACI+branch%3Adevelopment
.. image:: https://img.shields.io/readthedocs/flask-session?logo=readthedocs
:target: https://flask-session.readthedocs.io
:alt: Documentation status
.. image:: https://img.shields.io/github/license/pallets-eco/flask-session?logo=bsd
:target: ./LICENSE
:alt: BSD-3 Clause License
.. image:: https://common-changelog.org/badge.svg
:target: https://common-changelog.org
:alt: Common Changelog
.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json&label=style
:target: https://github.com/astral-sh/ruff
:alt: Code style: ruff
.. image:: https://img.shields.io/pypi/v/flask-session.svg?logo=pypi
:target: https://pypi.org/project/flask-session
:alt: PyPI - Latest Version
.. image:: https://img.shields.io/badge/dynamic/json?query=info.requires_python&label=python&logo=python&url=https%3A%2F%2Fpypi.org%2Fpypi%2Fflask-session%2Fjson
:target: https://pypi.org/project/Flask-Session/
:alt: PyPI - Python Version
.. image:: https://img.shields.io/discord/531221516914917387?logo=discord
:target: https://discord.gg/pallets
:alt: Discord
.. image:: https://img.shields.io/pypi/dm/flask-session?logo=pypi
:target: https://pypistats.org/packages/flask-session
:alt: PyPI - Downloads
Installing
------------
Install and update using pip:
.. code-block:: bash
$ pip install flask-session
A Simple Example
--------------------
.. code-block:: python
from flask import Flask, session
from flask_session import Session
app = Flask(__name__)
# Check Configuration section for more details
SESSION_TYPE = 'redis'
app.config.from_object(__name__)
Session(app)
@app.route('/set/')
def set():
session['key'] = 'value'
return 'ok'
@app.route('/get/')
def get():
return session.get('key', 'not set')
Supported Storage Types
------------------------
- Redis
- Memcached
- FileSystem
- MongoDB
- SQLALchemy
Documentation
-------------
Learn more at the official `Flask-Session Documentation <https://flask-session.readthedocs.io/en/latest/>`_.
Maintainers
------------
- `Lxstr <https://github.com/Lxstr>`_
- Pallets Team
Contribute
----------
Thanks to all those who have contributed to Flask-Session. A full list can be found at `CONTRIBUTORS.md <https://github.com/pallets-eco/flask-session/blob/development/CONTRIBUTORS.md>`_.
If you want to contribute, please check the `CONTRIBUTING.rst <https://github.com/pallets-eco/flask-session/blob/development/CONTRIBUTING.rst>`_.
Donate
--------
The Pallets organization develops and supports Flask-Session and other popular packages. In order to grow the community of contributors and users, and allow the maintainers to devote more time to the projects, please donate today.
|
