Skip to main content

FastAPIUIAuth

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

Python

Platform Supported

Platform

Deployments

pypi

Pypi Pypi-format Pypi-status

Installation

pip install FastAPI-UI-Auth

Usage

import logging
import uiauth

from fastapi import FastAPI
from fastapi.routing import APIRoute

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(
    # ------ MANDATORY ARGS ------
    app=app,
    routes=APIRoute(
        path="/private",
        endpoint=private_route
    ),
    username="admin",
    password="password123",
    # ------ OPTIONAL ARGS ------
    totp_token="JBSWSECUREDK3PXP",
    session_timeout=3600,
    fallback=uiauth.Fallback(button="GO BACK", path="/public"),
    custom_logger=logging.getLogger("my_custom_logger")
)

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

pypi-module

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

© Vignesh Rao

Licensed under the MIT License

Metadata

Release files for FastAPI-UI-Auth 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for FastAPI-UI-Auth 0.4.0
File Interpreter ABI Platform Actions
fastapi_ui_auth-0.4.0-py3-none-any.whl Python 3 none any Details for fastapi_ui_auth-0.4.0-py3-none-any.whl

Release files / fastapi_ui_auth-0.4.0-py3-none-any.whl

Download URL fastapi_ui_auth-0.4.0-py3-none-any.whl
Size 22.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a2df0223602cf45061a0192048a67323f3edff30dc046316d8d6b9efac5decd6
BLAKE2b-256 checksum
How to use checksums
cd3f3466e73815b383bbc8805829159152abd4c77d070cf185133d31ec91469e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.13

Security for FastAPI-UI-Auth 0.4.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page