nexus-platform

Nexus

The Ultimate Plugin-Based Application Platform - Build modular, scalable applications with ease.

Nexus revolutionizes application development by making everything a plugin. Create applications as collections of focused, reusable plugins that work together seamlessly.

✨ Key Features

• 🔌 Pure Plugin Architecture - Every feature is a plugin, ensuring complete modularity
• 🔥 Hot-Reload Support - Add, update, or remove plugins without restarting
• 🎯 FastAPI Integration - Modern async web framework with automatic OpenAPI docs
• 🛡️ Built-in Authentication - JWT-based auth with role-based access control
• 📊 Multi-Database Support - SQLAlchemy integration with PostgreSQL, MySQL, SQLite
• 🌐 API-First Design - Automatic REST API generation with Swagger UI
• ⚡ High Performance - Async/await throughout with optimized request handling
• 📈 Monitoring & Metrics - Health checks, metrics collection, and observability
• 🔧 CLI Tools - Powerful command-line interface for development and deployment

🚀 Quick Start

Installation

pip install nexus-platform

Create Your First Application

from nexus import create_nexus_app

app = create_nexus_app(
    title="My App",
    description="Built with Nexus",
    version="1.0.0"
)

if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="0.0.0.0", port=8000)

Your application runs at http://localhost:8000 with:

• API Docs: http://localhost:8000/docs
• Health Check: http://localhost:8000/health

Create Your First Plugin

nexus plugin create my_plugin

from nexus import BasePlugin
from fastapi import APIRouter

class MyPlugin(BasePlugin):
    def __init__(self):
        super().__init__()
        self.name = "my_plugin"
        self.version = "1.0.0"

    async def initialize(self) -> bool:
        self.logger.info("Plugin initialized!")
        return True

    def get_api_routes(self):
        router = APIRouter(prefix="/my-plugin", tags=["my-plugin"])

        @router.get("/")
        async def get_info():
            return {"plugin": self.name, "status": "active"}

        return [router]

def create_plugin():
    return MyPlugin()

📚 Documentation

🚀 Getting Started

• Installation - Install Nexus in 2 minutes
• Quick Start - Build your first app in 5 minutes
• First Plugin - Create your first plugin
• Configuration - Configure your application

🏗️ Architecture & Development

• Architecture Overview - System design and principles
• Plugin Basics - Build powerful plugins
• API Routes - Create REST endpoints
• Database Integration - Data persistence

📚 Complete Documentation

• Documentation Index - Full documentation structure
• API Reference - Complete framework reference
• Deployment Guide - Production deployment

🏗️ Architecture

graph TD
    A[Nexus App] --> B[Plugin Manager]
    A --> C[Event Bus]
    A --> D[Service Registry]
    A --> E[FastAPI Core]

    B --> F[Plugin 1]
    B --> G[Plugin 2]
    B --> H[Plugin N...]

    F --> C
    G --> C
    H --> C

    F --> D
    G --> D
    H --> D

🔧 CLI Tools

# Application management
nexus run --host 0.0.0.0 --port 8000
nexus init
nexus status
nexus health

# Plugin management
nexus plugin create <name>
nexus plugin list
nexus plugin info <name>

# Admin tools
nexus-admin system info
nexus-admin user create <username>
nexus-admin plugin status

📁 Project Structure

my-nexus-app/
├── main.py                    # Application entry point
├── nexus_config.yaml          # Configuration file
├── nexus/                     # Nexus framework core
├── plugins/                   # Plugin directory
├── plugin_template/           # Plugin development template
├── config/                    # Configuration files
└── pyproject.toml            # Package configuration

🌟 Core Components

Plugin Manager

Handles plugin lifecycle, loading, and dependency management with hot-reload support.

Event Bus

Asynchronous publish-subscribe system for loose coupling between plugins.

Service Registry

Dependency injection container for sharing services between plugins.

Authentication Manager

JWT-based authentication with role-based access control.

Database Adapter

Multi-database support with connection pooling and transaction management.

🤝 Contributing

We welcome contributions! Here's how to get started:

Development Setup

# Clone repository
git clone https://github.com/dnviti/nexus-platform.git
cd nexus

# Set up development environment
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install dependencies
poetry install --with dev,test

# Set up git hooks for quality assurance (RECOMMENDED)
python scripts/pre_push_check.py

# Verify setup
python scripts/test_ci_locally.py --fast

Quality Assurance

⚠️ IMPORTANT: Contributors should use git hooks to ensure code quality and reduce CI failures.

Automatic Setup (Recommended):

python scripts/pre_push_check.py  # Sets up pre-commit hooks automatically

Manual Setup:

git config core.hooksPath .githooks
chmod +x .githooks/*

What the hooks validate on each commit:

• ✅ Code formatting (Black)
• ✅ Import sorting (isort)
• ✅ Linting (Flake8)
• ✅ Type checking (MyPy)
• ✅ Security scanning (Bandit)
• ✅ Full test suite (496 unit + 16 integration tests)
• ✅ Code coverage analysis
• ✅ Build validation

Development Workflow

# Quick development validation
python scripts/pre_push_check.py --fast

# Make changes, then commit (triggers full validation)
git add .
git commit -m "Your meaningful commit message"

# Push after successful validation
git push

Note: Git hooks ensure every commit meets the same quality standards as our CI pipeline, significantly reducing development friction and CI failures.

See .githooks/README.md for detailed hook documentation.

📄 License

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

🔗 Links

• PyPI Package: https://pypi.org/project/nexus/
• GitHub Repository: https://github.com/dnviti/nexus-platform
• Issue Tracker: https://github.com/dnviti/nexus-platform/issues
• Discussions: https://github.com/dnviti/nexus-platform/discussions

🙏 Acknowledgments

• Built with FastAPI
• Powered by SQLAlchemy
• CLI built with Click

Made with ❤️ by the Nexus Team

Start building your next great application with Nexus today!