|
4 | 4 | <br> |
5 | 5 | </h1> |
6 | 6 |
|
7 | | -<h4 align="center">Adds support for Server-side Session to your Flask application.</h4> |
| 7 | +<h4 align="center">Adds support for Server-side Session to your [Flask](https://flask.palletsprojects.com) application.</h4> |
8 | 8 |
|
9 | | - |
10 | | -Welcome to Flask-Session's documentation. Flask-Session is an extension for [Flask](https://flask.palletsprojects.com) that adds support for Server-side `Session` to your application. |
| 9 | +<p align="center"> |
| 10 | +<a href="https://codecov.io/gh/christopherpickering/flask-session2" > <img src="https://codecov.io/gh/christopherpickering/flask-session2/branch/master/graph/badge.svg?token=97G1F34PKY"/> </a> |
| 11 | + <a href="https://www.codacy.com/gh/christopherpickering/flask-session2/dashboard?utm_source=github.com&utm_medium=referral&utm_content=christopherpickering/flask-session2&utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/4f05bcca902448b1aecacc51aa94d363"/></a> |
| 12 | +<a href="https://pepy.tech/project/flask-session2"> |
| 13 | + <img src="https://pepy.tech/badge/flask-session2" alt="Downloads"> |
| 14 | + </a> |
| 15 | + <a href="https://pypi.org/project/flask-session2/"> |
| 16 | + <img src="https://img.shields.io/pypi/v/flask-session2" alt="Pypi Download"> |
| 17 | + </a> |
| 18 | +</p> |
11 | 19 |
|
12 | 20 |
|
13 | 21 | ## Installation |
@@ -59,7 +67,7 @@ sess.init_app(app) |
59 | 67 | The following configuration values exist for Flask-Session. Flask-Session loads these values from your Flask application config, so you should configure |
60 | 68 | your app first before you pass it to Flask-Session. Note that these values cannot be modified after the ``init_app`` was applyed so make sure to not modify them at runtime. |
61 | 69 |
|
62 | | -We are not supplying something like ``SESSION_REDIS_HOST`` and ``SESSION_REDIS_PORT``, if you want to use the ``RedisSessionInterface``, you should configure ``SESSION_REDIS`` to your own ``redis.Redis`` instance. This gives you more flexibility, like maybe you want to use the same ``redis.Redis`` instance for cache purpose too, then you do not need to keep two ``redis.Redis`` instance in the same process. |
| 70 | +We are not supplying something like `SESSION_REDIS_HOST` and `SESSION_REDIS_PORT`, if you want to use the `RedisSessionInterface`, you should configure `SESSION_REDIS` to your own `redis.Redis` instance. This gives you more flexibility, like maybe you want to use the same `redis.Redis` instance for cache purpose too, then you do not need to keep two `redis.Redis` instance in the same process. |
63 | 71 |
|
64 | 72 | The following configuration values are builtin configuration values within Flask itself that are related to session. **They are all understood by |
65 | 73 | Flask-Session, for example, you should use PERMANENT_SESSION_LIFETIME to control your session lifetime.** |
@@ -109,15 +117,15 @@ session but fail on setting. |
109 | 117 |
|
110 | 118 | ### `RedisSessionInterface` |
111 | 119 |
|
112 | | -Uses the Redis key-value store as a session backend. ([redis-py](https://pypi.org/project/redis/) required) |
| 120 | +Uses the Redis key-value store as a session backend. ([redis-py](https://github.com/andymccurdy/redis-py) required) |
113 | 121 |
|
114 | 122 | Relevant configuration values: |
115 | 123 |
|
116 | 124 | - SESSION_REDIS |
117 | 125 |
|
118 | 126 | ### `MemcachedSessionInterface` |
119 | 127 |
|
120 | | -Uses the Memcached as a session backend. ([pymemcache](https://pypi.org/project/pymemcache/) required) |
| 128 | +Uses the Memcached as a session backend. ([pylibmc](http://sendapatch.se/projects/pylibmc/) or [memcache](https://github.com/linsomniac/python-memcached) required) |
121 | 129 |
|
122 | 130 | - SESSION_MEMCACHED |
123 | 131 |
|
@@ -145,3 +153,7 @@ Uses SQLAlchemy as a session backend. ([Flask-SQLAlchemy](https://pythonhosted.o |
145 | 153 |
|
146 | 154 | - SESSION_SQLALCHEMY |
147 | 155 | - SESSION_SQLALCHEMY_TABLE |
| 156 | + |
| 157 | +## Credits |
| 158 | + |
| 159 | +This project is a fork of [flask-session](https://github.com/fengsp/flask-session), created by [Shipeng Feng](https://github.com/fengsp). |
0 commit comments