PyIdentity

Pydentity is a flexible, high-performance identity and profile management middleware for FastAPI applications. It provides a robust set of tools to handle user authentication, authorization, and profile management, designed to be easily integrated and customized in existing FastAPI projects.

Features

Middleware-based integration for seamless FastAPI compatibility
Customizable routing with plugin architecture
Core services for JWT claims validation and management
MongoDB integration with Beanie ODM for efficient data management
User registration and authentication
Role-based access control
Profile management
Password hashing with Passlib
Email verification
Two-factor authentication (2FA)
GDPR-compliant data handling
Extensible architecture for custom identity providers

Tech Stack

FastAPI: Modern, fast web framework for building APIs with Python 3.6+
Beanie: Asynchronous Python object-document mapper (ODM) for MongoDB
Pydantic: Data validation and settings management
PyJWT: JSON Web Token implementation in Python
Passlib: Password hashing library
pytest: Testing framework

Installation

pip install pydentity

Quick Start

Add Pydentity middleware to your FastAPI application:

from fastapi import FastAPI
from pydentity import PydentityMiddleware, PydentityConfig

app = FastAPI()

identity_config = PyIdentityConfig(
    secret_key="your-secret-key",
    mongodb_url="mongodb://localhost:27017",
    token_expiration=3600
)

app.add_middleware(PyIdentityMiddleware, config=identity_config)

Use Pydentity decorators in your routes:

from pydentity import require_auth, get_current_user

@app.get("/protected")
@require_auth
async def protected_route(current_user = Depends(get_current_user)):
    return {"message": f"Hello, {current_user.username}!"}

Customize claims validation:

from pydentity import ClaimsValidator

class CustomClaimsValidator(ClaimsValidator):
    async def validate(self, claims: dict) -> bool:
        # Your custom validation logic here
        return claims.get("role") == "admin"

identity_config.set_claims_validator(CustomClaimsValidator())

Customizing Routes

PyIdentity allows you to easily customize or override default routes:

from pyidentity import PyIdentityRouter

custom_router = PydentityRouter()

@custom_router.post("/custom-login")
async def custom_login(credentials: dict):
    # Your custom login logic here
    pass

identity_config.set_router(custom_router)

Core Services

PyIdentity provides core services that you can use in your application:

from pydentity import get_token_service, get_user_service

@app.get("/user-info")
async def get_user_info(token: str):
    token_service = get_token_service()
    user_service = get_user_service()
    
    claims = await token_service.validate_token(token)
    user = await user_service.get_user_by_id(claims["sub"])
    return user

Documentation

For full documentation, visit pydentity.readthedocs.io.

Contributing

We welcome contributions! Please see our Contributing Guide for more details.

License

Pydentity is released under the MIT License. See the LICENSE file for more details.

Support

If you encounter any problems or have any questions, please open an issue on GitHub.

onlythompson/pydentity