🌌 Orix X

   ____         _       
  / __ \_______(_)  __  
 / / / / __/ __/ / |/_/  
/ /_/ / / / / / />  <    
\____/_/ /_/ /_/_/|_|    

⚡ UNIVERSAL PROJECT GENERATION PLATFORM ⚡
       Engineered by Kryonara • Version 2.0.0

Orix X is a plugin-based CLI that scaffolds production-ready project boilerplate in seconds. Instead of hardcoding a generator for every stack, Orix loads framework support as plugins at runtime, renders Jinja2 templates into a target directory, and gives you a clean starting point — optionally with Docker and auth wired in.

It's built to be driven by humans (interactive prompts) or by automation/AI agents (deterministic CLI flags) — making it equally useful as a personal scaffolding tool or as a building block in larger agentic dev workflows.

---

🚀 Key Features

• Plugin-based architecture — Each framework (React, Django, FastAPI) is a self-contained plugin built on a shared SDK (BasePlugin / FrameworkPlugin). Adding a new framework means writing a new plugin, not touching the core.
• Modular core engine — Orchestration, plugin discovery, and template rendering are fully decoupled (Orchestrator, PluginManager, TemplateRenderer).
• Interactive TUI — A rich + questionary powered terminal experience: banner, framework picker, and dynamic per-framework option prompts.
• Deterministic CLI mode — Every interactive choice has a CLI flag equivalent, so the entire tool can be scripted or called by an AI agent without any prompts.
• Recursive Jinja2 templating — Templates support placeholders in file contents, file names, and directory names, rendered recursively into the generated project.
• Auto-loaded plugins — Drop a new plugin file into orix/plugins/, and PluginManager discovers and loads it automatically via introspection — no manual registration step.

---

🛠️ Architecture

orix/
├── core/
│   ├── cli.py             # Click-based CLI entrypoint (orix create)
│   ├── orchestrator.py    # Wires plugins + renderer together, drives generation
│   ├── plugin_manager.py  # Discovers and loads plugins from orix/plugins/
│   ├── renderer.py        # Recursive Jinja2 template renderer
│   └── ui.py               # TUI: banner, prompts (rich + questionary)
├── sdk/
│   └── base.py             # BasePlugin / FrameworkPlugin abstract classes
├── plugins/
│   ├── react.py            # React framework plugin
│   ├── django.py           # Django framework plugin
│   └── fastapi.py          # FastAPI framework plugin
└── templates/
    ├── react/               # React project template
    ├── django/              # Django project template
    └── fastapi/             # FastAPI project template

How it works under the hood:

1. PluginManager scans orix/plugins/, dynamically imports every module, and registers any class that subclasses BasePlugin.
2. cli.py lists the available frameworks and, in interactive mode, prompts you to pick one and answer its get_questions() (e.g. "Include Docker?").
3. Orchestrator.generate() builds a context dict from your project name + answers + the plugin's get_context() output (e.g. Django gets an auto-generated secret_key).
4. TemplateRenderer walks the matching template folder under orix/templates/, rendering directory names, file names, and file contents through Jinja2, and writes the result to your target folder.

---

📦 Installation

git clone https://github.com/fagiteemmanuel4-bit/Orix.git
cd Orix
pip install -e .

Requires Python 3.10+.

---

🚀 Usage

Interactive mode (human-friendly)

orix create

You'll get the Orix banner, a framework picker, and prompts for any options the chosen framework supports (Docker, auth, etc).

Deterministic mode (scriptable / AI-agent-friendly)

orix create my-project --framework react --docker --auth

All flags can be mixed — anything you don't pass will fall back to an interactive prompt for that option.

Supported flags:

Flag	Description
project_name	Name of the project / output folder (positional, optional)
--framework	One of: react, django, fastapi
--docker / --no-docker	Include Docker configuration
--auth / --no-auth	Include auth boilerplate (JWT for FastAPI, DRF auth for Django, auth scaffolding for React)

---

🔌 Currently Supported Frameworks

Framework	Docker	Auth
React	✅	✅
Django	✅	✅ (DRF)
FastAPI	✅	✅ (JWT)

---

🧩 Writing Your Own Plugin

Orix is designed so new framework support doesn't require touching the core. To add one:

1. Create orix/plugins/<name>.py with a class extending FrameworkPlugin from orix.sdk.base.
2. Implement name, get_template_name(), get_questions(), and get_context().
3. Add a matching template folder under orix/templates/<name>/ using Jinja2 placeholders for any dynamic content, file names, or folders.
4. Drop it in — PluginManager will discover it automatically on the next run.

---

🧪 Development

pytest

---

📄 License

Orix X is open-source software licensed under the MIT License.