You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
150 lines
5.1 KiB
150 lines
5.1 KiB
Metadata-Version: 2.1
|
|
Name: Flask-Session
|
|
Version: 0.8.0
|
|
Summary: Server-side session support for Flask
|
|
Author-email: Shipeng Feng <fsp261@gmail.com>
|
|
Maintainer-email: Pallets Community Ecosystem <contact@palletsprojects.com>
|
|
Requires-Python: >=3.8
|
|
Description-Content-Type: text/x-rst
|
|
Classifier: Development Status :: 4 - Beta
|
|
Classifier: Environment :: Web Environment
|
|
Classifier: Framework :: Flask
|
|
Classifier: Intended Audience :: Developers
|
|
Classifier: License :: OSI Approved :: BSD License
|
|
Classifier: Operating System :: OS Independent
|
|
Classifier: Programming Language :: Python
|
|
Classifier: Topic :: Internet :: WWW/HTTP :: Session
|
|
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI
|
|
Classifier: Topic :: Internet :: WWW/HTTP :: WSGI :: Application
|
|
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
|
|
Requires-Dist: flask>=2.2
|
|
Requires-Dist: msgspec>=0.18.6
|
|
Requires-Dist: cachelib
|
|
Requires-Dist: Flask-Session[cachelib, memcached, mongodb, redis, sqlalchemy] ; extra == "all"
|
|
Requires-Dist: cachelib>=0.10.2 ; extra == "cachelib"
|
|
Requires-Dist: pymemcache ; extra == "memcached"
|
|
Requires-Dist: pymongo>=4.6.2 ; extra == "mongodb"
|
|
Requires-Dist: redis>=5.0.3 ; extra == "redis"
|
|
Requires-Dist: flask-sqlalchemy>=3.0.5 ; extra == "sqlalchemy"
|
|
Project-URL: Changes, https://flask-session.readthedocs.io/changes.html
|
|
Project-URL: Chat, https://discord.gg/pallets
|
|
Project-URL: Documentation, https://flask-session.readthedocs.io
|
|
Project-URL: Issue Tracker, https://github.com/pallets-eco/flask-session/issues/
|
|
Project-URL: Source Code, https://github.com/pallets-eco/flask-session/
|
|
Provides-Extra: all
|
|
Provides-Extra: cachelib
|
|
Provides-Extra: memcached
|
|
Provides-Extra: mongodb
|
|
Provides-Extra: redis
|
|
Provides-Extra: sqlalchemy
|
|
|
|
.. 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.
|
|
|
|
|
|
|