djinn-ui 0.1.3

A shadcn-style component installer for Django.

Djinn UI

Djinn is a shadcn-style component system for Django.

It lets developers visually build, install, and own UI components directly inside their Django projects using a simple CLI.

---

✨ Philosophy

Djinn is NOT a UI framework.

Djinn is a source-code delivery system.

Once a component is installed, it belongs to your project — fully editable, fully owned.

---

⚡ Features

• CLI-based component installation (init, add, list, view, docs)
• Registry-driven architecture with custom namespace routing (e.g. @internal/)
• Model Context Protocol (MCP) Server for AI Assistant integrations (Claude Code, Cursor)
• Copy-paste ownership model (like shadcn/ui)
• Django-native templates with {% cn %} tailwind-merge utility tag
• TailwindCSS-based styling with dynamic CSS variables
• Alpine.js / HTMX support
• Versioned components with a diff/update system

---

📦 Installation (CLI)

pip install djinn-ui

---

🚀 Quick Start

Initialize Djinn in your Django project:

python -m djinn init

Add a component from the default registry:

python -m djinn add button

Add a component from a custom namespace (configured in djinn.json):

python -m djinn add @internal/dashboard-card

Other useful commands:

• python -m djinn view card: Preview a component's source code before installing.
• python -m djinn docs button: Open the documentation for a component in your browser.
• python -m djinn info: Display your current project configuration and registries.
• python -m djinn mcp: Start the Model Context Protocol (MCP) server to allow AI assistants (like Cursor and Claude Code) to install components for you automatically.

---

🧩 Example Component Usage

{% load djinn_tags %}
<div class="{% cn 'base-classes' dynamic_class %}">
  {% include "components/button.html" %}
</div>

---

📁 Registry System

Djinn components are stored in a remote registry:

• Each component is versioned
• Includes templates, logic, and metadata
• CLI fetches and installs directly into your project

---

🏗 Architecture

Registry → CLI → Django Project

No runtime dependency. No locked library. You own the code.

---

🔮 Roadmap

• Visual Component Builder (Djinn Canvas)
• AI component generator
• Component marketplace
• Figma import
• Team registries

---

🤝 Contribution

We welcome contributions to:

• Registry components
• CLI improvements
• Documentation