FastAPI-UI-Auth 0.0.1a0

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

FastAPIAuthenticator

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

Platform Supported

Installation

repo="thevickypedia/FastAPIAuthenticator"

latest=$(curl -s https://api.github.com/repos/${repo}/tags | jq -r '.[0].name')

pip install "git+https://github.com/${repo}.git@${latest}"

Usage

import fastapiauthenticator as api

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"}

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

FastAPIAuthenticator 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

License & copyright

© Vignesh Rao

Licensed under the MIT License