Home

⚡ XCore Framework

High-performance, plugin-first orchestration framework built on FastAPI.

from fastapi import FastAPI from xcore import Xcore from contextlib import asynccontextmanager # 1. Initialize the Kernel xcore = Xcore(config_path="xcore.yaml") @asynccontextmanager async def lifespan(app: FastAPI): # 2. Boot XCore (loads plugins and services) await xcore.boot(app) yield # 3. Graceful shutdown await xcore.shutdown() app = FastAPI(lifespan=lifespan) @app.get("/compute") async def compute(value: int): # 4. Call a plugin method dynamically result = await xcore.plugins.call("math_plugin", "calculate", {"x": value}) return {"result": result}

🚀 Getting Started

Installation

# Clone the repository
git clone https://github.com/traoreera/xcore.git
cd xcore

# Install using Poetry
make install

Quick Run

Start the development server with auto-reload enabled:

make dev

🏗️ Architecture

XCore follows a "minimal core" philosophy. Most business logic resides in plugins, which are managed by the Plugin Supervisor.

flowchart TB
    subgraph Core["XCore Kernel"]
        X[Orchestrator] --> PS[Plugin Supervisor]
        X --> EB[Event Bus]
        X --> SC[Service Container]
    end

    PS --> Trusted[Trusted Plugins]
    PS --> Sandbox[Sandboxed Plugins]

    SC --> DB[(Database)]
    SC --> RD[(Redis)]
    SC --> SCH[Scheduler]

🛠️ CLI Reference

The xcore CLI is your control center for managing the framework.

Command	Description
`xcore plugin list`	List all loaded plugins
`xcore plugin reload <name>`	Hot-reload a plugin without restarting the server
`xcore plugin info <name>`	Inspect plugin manifest and permissions
`xcore plugin sign <path>`	Generate a security signature for a plugin
`xcore services status`	Check the health of DB, Cache, and Scheduler
`xcore health`	Perform a global system health check
`xcore worker start`	Start the background task worker

🧪 Development & Quality

We maintain high standards for code quality and security:

make test              # Run the full test suite
make lint-fix          # Auto-format and fix linting issues
make security-check    # Run Bandit security audit
make benchmark         # Run performance benchmarks

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.

Built with ❤️ by the XCore Team

Navigation Menu