Files
overub/docs/API_REFERENCE.md
2025-12-21 17:12:32 +01:00

50 lines
1.1 KiB
Markdown

# OverUB API Reference
## Plugin Base Class
See `core/plugin.py` for the base class and lifecycle hooks.
## Event System
See `core/events.py` for event dispatch, cancellation, and priorities.
## Command System
See `core/commands.py` for command registration and parsing.
## Message Bus
See `core/bus.py` for pub/sub and shared service registry.
## Cache
See `core/cache.py` for in-memory LRU cache helpers.
## Plugin Database
See `core/database.py` for `PluginDatabase` key-value helpers.
## Backups
See `core/backup.py` for basic backup utilities.
## Backup Scheduler
See `core/backup_service.py` for scheduled backup automation.
## Scheduler
See `core/scheduler.py` for scheduling helpers.
## Update Service
See `core/update_service.py` for update scheduling and notifications.
## Gitea Client
See `core/gitea.py` for basic API integration.
## Sandbox
See `core/sandbox.py` for plugin sandbox helpers.
## HTTP Session
See `core/http.py` for shared HTTP session access.
## Monitoring
See `core/monitor.py` for CPU/memory stats.
## Rate Limiting
See `core/rate_limiter.py` for rate limiter helpers.
## Migrations
See `core/migrations.py` for migration hooks.