Skip to content

Fast Pluggy

Welcome to the Fast Pluggy documentation!

Overview

Fast Pluggy is a plugin system for FastAPI applications that allows you to extend your application's functionality through plugins.

Features

  • Plugin Management: Easily install, enable, disable, and manage plugins
  • FastAPI Integration: Seamlessly integrates with FastAPI applications
  • Extensible Architecture: Build and share plugins for common functionality
  • Admin Interface: Web-based interface for managing plugins
  • API-driven: Full API for programmatic control of plugins

Getting Started

Check out the Getting Started guide to begin using Fast Pluggy in your FastAPI applications.

Installation

pip install fastpluggy

For more detailed installation instructions, see the Installation Guide.

Quick Example

from fastapi import FastAPI
from fastpluggy import FastPluggy

app = FastAPI()

# Initialize Fast Pluggy with custom plugin and module paths
pluggy = FastPluggy(
    app,
    app_root_dir=".",          # Root directory of your application
    path_plugins="./plugins",  # Directory where plugins are stored
    path_modules="./domains"   # Directory where domain modules are stored
)

# The rest of your FastAPI application
@app.get("/")
def read_root():
    return {"Hello": "World"}

Contributing

Contributions are welcome! Please see our Contributing Guide for more information.