FastAPIUIAuth

Python module to add username and password authentication to specific FastAPI routes

Platform Supported

Deployments

Installation

pip install FastAPI-UI-Auth

Usage

import uiauth

from fastapi import FastAPI

app = FastAPI()

@app.get("/public")
async def public_route():
    return {"message": "This is a public route"}

async def private_route():
    return {"message": "This is a private route"}

uiauth.protect(
    app=app,
    params=uiauth.Parameters(
        path="/private",
        function=private_route
    )
)

FastAPI-UI-Auth supports both APIRoute and APIWebSocketRoute routes.
Refer samples directory for different use-cases.

Coding Standards

Docstring format: Google
Styling conventions: PEP 8 and isort

Release Notes

Requirement

python -m pip install gitverse

Usage

gitverse-release reverse -f release_notes.rst -t 'Release Notes'

Linting

Requirement

python -m pip install sphinx==5.1.1 pre-commit recommonmark

Usage

pre-commit run --all-files

Pypi Package

https://pypi.org/project/FastAPI-UI-Auth/

License & copyright

© Vignesh Rao

Licensed under the MIT License