No project description provided
Project description
Muffin-Session – Implement an user sessions in Muffin Framework.
Requirements
python >= 3.3
Installation
Muffin-Session should be installed using pip:
pip install muffin-session
Usage
Add muffin_session to PLUGINS in your Application configuration.
Setup options if needed (see bellow).
Options
SESSION_AUTO_LOAD – Load session every request automatically Session will be loaded into request.session.
SESSION_DEFAULT_USER_CHECKER – A function which checks logged user (lambda x: x)
SESSION_LOGIN_URL – Redirect URL (‘/login’), or it may be a function which accepts request object and returns a string.
SESSION_SECRET – A secret code (‘Insecuresecret’)
SESSION_MAX_AGE – # Defines the lifetime of the session-cookie, in seconds
SESSION_DOMAIN – # Defines session-cookie domain
Examples
@app.ps.session.user_loader
def load_user(_id):
"""Define your own user loader. """
@app.register('/session')
def get_session(request):
""" Load session and return it as JSON. """
session = yield from app.ps.session(request)
return dict(session)
@app.register('/admin')
@app.ps.session.user_pass(lambda u: u.is_admin)
def admin(request):
""" Check for user is admin. """
@app.register('/login')
def login(request):
""" Login user. """
# ...
yield from app.ps.session.login(current_user.pk)
@app.register('/logout')
def logout(request):
""" Logout user. """
# ...
yield from app.ps.session.logout(curuser.pk)
@app.register('/somewhere')
def somewhere(request):
""" Do something and leave a flash message """
# ...
yield from app.ps.session.flash('Something done successfully')
@app.register('/common')
def common_page(request):
"""
This can be included in any endpoint which outputs regular page.
If you use jinja2 or other templating engine,
you will need to pass `request` to its context somehow.
Also this plugin will register `get_flashed_messages` function in Jinja2 context,
but only if Jinja2 plugin was loaded before this one.
"""
# first we want to ensure that session is loaded,
yield from app.ps.session.load()
# this method is *not* a coroutine, so it can be used in templates
messages = app.ps.session.get_flashed_messages()
return (
"<html><body><header>%s</header> Other content </body></html>" %
'<br/>'.join(messages)
)
Bug tracker
If you have any suggestions, bug reports or annoyances please report them to the issue tracker at https://github.com/klen/muffin-session/issues
Contributing
Development of Muffin-Session happens at: https://github.com/klen/muffin-session
Contributors
klen (Kirill Klenov)
License
Licensed under a MIT license.
If you wish to express your appreciation for the project, you are welcome to send a postcard to:
Kirill Klenov pos. Severny 8-3 MO, Istra, 143500 Russia
Release history Release notifications | RSS feed
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
File details
Details for the file muffin-session-0.5.0.tar.gz.
File metadata
- Download URL: muffin-session-0.5.0.tar.gz
- Upload date:
- Size: 7.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e203931dbd9f60ef29edc5d829af8747ff2cddd391283ebae6e490e6af2d94f3 |
|
| MD5 | 3cabdd0339d8b7ae4ee01de3e635f666 |
|
| BLAKE2b-256 | 30f5cff224fe96cca9d46921b310fd308239a6e01e81a3da53ac568e71cc8b11 |
File details
Details for the file muffin_session-0.5.0-py2.py3-none-any.whl.
File metadata
- Download URL: muffin_session-0.5.0-py2.py3-none-any.whl
- Upload date:
- Size: 8.3 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0187321b0b38fa5fbc3b4decf634309653302d4647149af79e69c58ca964e82a |
|
| MD5 | 696386fcae3044b92d95a88c8dfa8f43 |
|
| BLAKE2b-256 | 9ac3eab32e92abc7d5e2661ba44211ce406068bcc71b5453586efd53acdef0ab |
