Skip to main content

A dependency-based extension for FastAPI that adds support for server-sided session management

Project description

FastAPI Server-sided Session

License: MIT Code Style: Black pyvers

FastAPI Server Session is a dependency-based extension for FastAPI that adds support for server-sided session management.

At the moment, it supports using Redis as the session datastore. But in the future, it will support even more datastores including but not limited to SQL, MongoDB, etc.

Quickstart

from fastapi import Depends, FastAPI
from fastapi_server_session import SessionManager, RedisSessionInterface, Session

import redis

api = FastAPI()

session_manager = SessionManager(
    interface=RedisSessionInterface(redis.from_url("redis://localhost"))
)

@api.get("/set")
async def set_session(session: Session = Depends(session_manager.use_session)):
    session["key"] = "value"
    return {"status": "ok"}

@api.get("/get")
async def get_session(session: Session = Depends(session_manager.use_session)):
    return {"value": session["key"]} # or session.get("key")

Contributing

If you are considering to contribute, thanks a lot! We welcome all contributors here and, you can help out as well.

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT License

Copyright (c) 2022 DevGuyAhnaf

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

fastapi_server_session-0.0.1-py3-none-any.whl (8.6 kB view details)

Uploaded Python 3

File details

Details for the file fastapi_server_session-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: fastapi_server_session-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 8.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.10.0 pkginfo/1.8.2 requests/2.22.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.10

File hashes

Hashes for fastapi_server_session-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 859f9af77a093ae257f0fb30cccda2b970084664925278f5c4da7841350c9e85
MD5 c32ffed75994b22f0fda5aaa93086397
BLAKE2b-256 2d712add751412ffe47d69aeb8697b964f2b474366f31cb6a350896dd3efa6f8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page