fastpluggy-example-plugin

No description available

v0.2.1
546 downloads this week
Latest version
Requires Python >=3.8

Quick Install

pip install fastpluggy-example-plugin
Or with specific version:
pip install fastpluggy-example-plugin==0.2.1

Example Plugin for FastPluggy

This is a template plugin that demonstrates the basic structure and capabilities of a FastPluggy plugin.
Use this as a starting point for your own plugins.

Structure

example_plugin/
├── __init__.py          # Package initialization
├── plugin.py            # Plugin class definition
├── README.md            # This file
└── router/
    └── __init__.py      # API endpoints

Features

This example plugin demonstrates:

  1. Basic plugin structure and required attributes
  2. Adding API endpoints with FastAPI
  3. Creating UI components with the view builder
  4. Adding menu items
  5. Registering global objects
  6. Interacting with other plugins

How to Use This Template

  1. Copy the example_plugin directory to your project
  2. Rename the directory to your plugin name
  3. Update the plugin class in plugin.py:
    - Change the class name
    - Update the module_name, module_version, and other attributes
    - Modify the on_load_complete method as needed
  4. Update the router in router/__init__.py:
    - Modify the existing endpoints or add new ones
    - Update the UI components

Plugin Class

The plugin class in plugin.py inherits from FastPluggyBaseModule and defines:

  • Required attributes: module_name, module_version
  • UI-related attributes: module_menu_name, module_menu_icon, module_menu_type
  • Optional attributes: module_router, extra_js_files
  • Optional dependencies on other plugins
  • An on_load_complete method for initialization tasks

API Endpoints

The router in router/__init__.py defines several example endpoints:

  • /: Main index page
  • /feature: Example feature page
  • /about: About page

Each endpoint uses the view builder to generate HTML responses with various UI components.

Next Steps

After customizing this template for your needs, refer to the Plugin Development Guide for more advanced features and capabilities.

No Changelog Available

This plugin does not have a Changelog file or it could not be extracted from the package.

fastpluggy-example-plugin API

API documentation for this plugin is not available.

Package Analysis

Last analysis performed: 2025-07-06 19:24:20

✓ Valid Entry Point

This plugin has a valid entry point:
example_plugin = fastpluggy_plugin.example_plugin.plugin:ExamplePlugin

Issues Found

Issues were found during analysis, but details are not available.

v0.2.1

Latest

Plugin Information

Name
fastpluggy-example-plugin
Version
0.2.1
Entry Point
fastpluggy_plugin.example_plugin.plugin:ExamplePlugin
Python
>=3.8
Status
Community

Dependencies

fastpluggy
Core framework
Framework
fastapi
Web framework
Web
sqlalchemy
ORM library
Database
pydantic
Data validation
Validation
jinja2
Template engine
Templates
PyJWT
JWT implementation
Authentication
bcrypt
Password hashing
Security
python-jose
JOSE implementation
Security
passlib
Password hashing library
Security
python-multipart
Form data parsing
Web
aiofiles
Asynchronous file operations
I/O
requests
HTTP client
Web
httpx
Async HTTP client
Web
uvicorn
ASGI server
Web
pytest
Testing framework
Testing
python-socketio[client]
Python Socket.IO client plugin
WebSocket
FastPluggy
Core framework for plugin-based Python applications
Framework
websockets
Library for building WebSocket servers and clients in Python
WebSocket
faster_whisper
None
GitPython
None
gpiozero
None
fastpluggy-ui-tools
UI components and developer tools for building FastPluggy-based interfaces
UI
loguru
Simple yet powerful logging library for Python applications
Logging
alembic
Lightweight database migration tool for SQLAlchemy applications
Database migration
fastpluggy-crud-tools
Automatic CRUD endpoint generation tools for FastPluggy projects
Utilities
psutil
Cross-platform library for retrieving information on running processes and system utilization
System monitoring
babel
Comprehensive i18n and localization library for Python
Internationalization
redis
Python client for the Redis key–value store
Cache/Database
pympler
Development utilities to measure, monitor and analyze Python object memory usage
Profiling
tomli
TOML parser for Python
Parsing
questionary
Interactive command-line user prompts
CLI prompts
ollama
Python client for managing Ollama local large language models
AI/LLM
prometheus-fastapi-instrumentator
Prometheus metrics instrumentation for FastAPI applications
Monitoring
prometheus_client
Official Prometheus instrumentation client for Python
Monitoring

Download Statistics

546
Weekly
2341
Monthly
3121
Total

Download Frequency: ~3 downloads per hour
Average Per Day: 78.0 downloads
Last Download: 13 days ago
Yearly Estimate: 28479 downloads
100% estimated growth rate based on 40 days of data