djinn-ui 0.1.0__tar.gz

djinn_ui-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SoJab Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

djinn_ui-0.1.0/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.4
+Name: djinn-ui
+Version: 0.1.0
+Summary: A shadcn-style component installer for Django.
+Author-email: Djinn Team <hello@djinn.dev>
+License: MIT License
+        
+        Copyright (c) 2026 SoJab Team
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/josephjbassey/djinn
+Project-URL: Repository, https://github.com/josephjbassey/djinn
+Project-URL: Bug Tracker, https://github.com/josephjbassey/djinn/issues
+Keywords: django,shadcn,components,cli,frontend
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Framework :: Django
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.4.1
+Requires-Dist: tabulate>=0.10.0
+Requires-Dist: importlib-resources; python_version < "3.9"
+Dynamic: license-file
+
+# 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
+* Registry-driven architecture
+* Copy-paste ownership model (like shadcn/ui)
+* Django-native templates
+* TailwindCSS-based styling
+* Alpine.js / HTMX support
+* Versioned components
+* Diff and update system
+
+---
+
+## 📦 Installation (CLI)
+
+```bash
+pip install djinn-ui
+```
+
+---
+
+## 🚀 Quick Start
+
+Initialize Djinn in your Django project:
+
+```bash
+djinn init
+```
+
+Add a component:
+
+```bash
+djinn add button
+```
+
+---
+
+## 🧩 Example Component Usage
+
+```django
+{% include "components/button.html" %}
+```
+
+---
+
+## 📁 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

djinn_ui-0.1.0/README.md

@@ -0,0 +1,102 @@
+# 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
+* Registry-driven architecture
+* Copy-paste ownership model (like shadcn/ui)
+* Django-native templates
+* TailwindCSS-based styling
+* Alpine.js / HTMX support
+* Versioned components
+* Diff and update system
+
+---
+
+## 📦 Installation (CLI)
+
+```bash
+pip install djinn-ui
+```
+
+---
+
+## 🚀 Quick Start
+
+Initialize Djinn in your Django project:
+
+```bash
+djinn init
+```
+
+Add a component:
+
+```bash
+djinn add button
+```
+
+---
+
+## 🧩 Example Component Usage
+
+```django
+{% include "components/button.html" %}
+```
+
+---
+
+## 📁 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

djinn_ui-0.1.0/djinn/__main__.py

@@ -0,0 +1,4 @@
+from djinn.cli.main import cli
+
+if __name__ == "__main__":
+    cli()

djinn_ui-0.1.0/djinn/cli/commands/add.py

@@ -0,0 +1,36 @@
+import click
+from djinn.core.config import Config, DEFAULT_CONFIG
+from djinn.core.registry import Registry
+from djinn.core.installer import Installer
+
+@click.command()
+@click.argument("component")
+@click.option("--force", is_flag=True, help="Overwrite existing files.")
+def add(component, force):
+    """Add a component to the project."""
+    config = Config.load()
+    if not config:
+        # Fallback to bundled registry if not initialized
+        registry_url = DEFAULT_CONFIG["registry_url"]
+        config = Config(
+            registry_url=registry_url,
+            output=DEFAULT_CONFIG["output"]
+        )
+        click.echo("Djinn not initialized. Using bundled registry defaults.")
+    else:
+        registry_url = config.registry_url
+
+    registry = Registry(registry_url)
+    installer = Installer(config, registry)
+
+    try:
+        installed_files = installer.install(component, force=force)
+        click.echo(f"Successfully installed '{component}':")
+        for _, path in installed_files:
+            click.echo(f"  - {path}")
+    except FileExistsError as e:
+        raise click.ClickException(f"{e} Use --force to overwrite.")
+    except (ValueError, FileNotFoundError) as e:
+        raise click.ClickException(str(e))
+    except Exception as e:
+        raise click.ClickException(f"An unexpected error occurred: {e}")

djinn_ui-0.1.0/djinn/cli/commands/diff.py

@@ -0,0 +1,67 @@
+import click
+from pathlib import Path
+from djinn.core.config import Config, DEFAULT_CONFIG
+from djinn.core.registry import Registry
+from djinn.core.utils import calculate_hash
+
+@click.command()
+@click.argument("component")
+def diff(component):
+    """Compare registry version vs local installed version."""
+    config = Config.load()
+    if not config:
+        registry_url = DEFAULT_CONFIG["registry_url"]
+        config = Config(registry_url=registry_url, output=DEFAULT_CONFIG["output"])
+        click.echo("Djinn not initialized. Diffing against bundled registry.")
+    else:
+        registry_url = config.registry_url
+
+    registry = Registry(registry_url)
+    metadata = registry.load_component(component)
+
+    if not metadata:
+        raise click.ClickException(f"Component '{component}' not found in registry.")
+
+    click.echo(f"Diffing '{component}' (Registry Version: {metadata.version}):")
+
+    any_diff = False
+    for file_type, file_name in metadata.files.items():
+        if file_type == "template":
+            dest_base = Path(metadata.install.get("template_path", config.get_template_path()))
+        elif file_type == "python":
+            dest_base = Path(metadata.install.get("python_path", config.get_python_path()))
+        else:
+            click.echo(f"  [WARNING] Unknown file type '{file_type}' for {file_name}. Skipping.")
+            continue
+
+        dest_path = dest_base / file_name
+        registry_file_path = registry.get_component_file_path(component, file_name)
+
+        try:
+            # Fetch registry content
+            src_content = registry.fetch_content(registry_file_path)
+            src_hash = calculate_hash(src_content)
+        except Exception:
+            click.echo(f"  [MISSING_REGISTRY] {registry_file_path}")
+            any_diff = True
+            continue
+
+        if not dest_path.exists():
+            click.echo(f"  [MISSING_LOCAL]    {dest_path}")
+            any_diff = True
+            continue
+
+        try:
+            dest_hash = calculate_hash(dest_path)
+
+            if src_hash != dest_hash:
+                click.echo(f"  [CHANGED] {dest_path}")
+                any_diff = True
+            else:
+                click.echo(f"  [MATCH]   {dest_path}")
+        except Exception as e:
+            click.echo(f"  [ERROR]   Could not diff {dest_path}: {e}")
+            any_diff = True
+
+    if not any_diff:
+        click.echo("Local version matches registry version.")

djinn_ui-0.1.0/djinn/cli/commands/init.py

@@ -0,0 +1,50 @@
+import click
+import os
+from djinn.core.config import Config, DEFAULT_CONFIG
+
+@click.command()
+@click.option("--yes", "-y", is_flag=True, help="Skip interactive prompts and use defaults.")
+@click.option("--defaults", is_flag=True, help="Skip interactive prompts and use defaults.")
+def init(yes, defaults):
+    """Initialize Djinn in the current project."""
+    if Config.load():
+        if not click.confirm("Djinn is already initialized. Overwrite existing configuration?", default=False):
+            return
+
+    if yes or defaults:
+        config = Config.init()
+        click.echo(f"Initialized djinn.config.json with defaults.")
+        return
+
+    # Interactive prompts
+    registry_url = click.prompt(
+        "Registry URL (or path)",
+        default=DEFAULT_CONFIG["registry_url"]
+    )
+
+    template_path = click.prompt(
+        "Where should Django templates be installed?",
+        default=DEFAULT_CONFIG["output"]["templates"]
+    )
+
+    python_path = click.prompt(
+        "Where should Python component files be installed?",
+        default=DEFAULT_CONFIG["output"]["python"]
+    )
+
+    config_data = {
+        "registry_url": registry_url,
+        "output": {
+            "templates": template_path,
+            "python": python_path
+        }
+    }
+
+    config = Config(
+        registry_url=config_data["registry_url"],
+        output=config_data["output"]
+    )
+    config.save()
+
+    click.echo("\nDjinn initialized successfully!")
+    click.echo(f"Config saved to djinn.config.json")

djinn_ui-0.1.0/djinn/cli/commands/list.py

@@ -0,0 +1,27 @@
+import click
+from tabulate import tabulate
+from djinn.core.config import Config, DEFAULT_CONFIG
+from djinn.core.registry import Registry
+
+@click.command()
+def list_components():
+    """List available components in the registry."""
+    config = Config.load()
+    if config:
+        registry_url = config.registry_url
+    else:
+        registry_url = DEFAULT_CONFIG["registry_url"]
+        click.echo("Djinn not initialized. Showing components from bundled registry.")
+
+    try:
+        registry = Registry(registry_url)
+        components = registry.list_components()
+
+        if not components:
+            click.echo(f"No components found in registry: {registry_url}")
+            return
+
+        table_data = [[c.name, c.version] for c in components]
+        click.echo(tabulate(table_data, headers=["Component", "Version"], tablefmt="simple"))
+    except Exception as e:
+        raise click.ClickException(f"Failed to list components: {e}")

djinn_ui-0.1.0/djinn/cli/main.py

@@ -0,0 +1,19 @@
+import click
+from djinn.cli.commands.init import init
+from djinn.cli.commands.add import add
+from djinn.cli.commands.list import list_components
+from djinn.cli.commands.diff import diff
+
+@click.group()
+@click.version_option()
+def cli():
+    """Djinn: A shadcn-style component installer for Django."""
+    pass
+
+cli.add_command(init)
+cli.add_command(add)
+cli.add_command(list_components, name="list")
+cli.add_command(diff)
+
+if __name__ == "__main__":
+    cli()

djinn_ui-0.1.0/djinn/core/config.py

@@ -0,0 +1,57 @@
+import json
+import os
+from pathlib import Path
+from typing import Dict, Any, Optional
+
+CONFIG_FILE = "djinn.config.json"
+
+DEFAULT_CONFIG = {
+    "registry_url": "__bundled__",
+    "output": {
+        "templates": "templates/components",
+        "python": "components"
+    }
+}
+
+class Config:
+    def __init__(self, registry_url: str, output: Dict[str, str]):
+        self.registry_url = registry_url
+        self.output = output
+
+    @classmethod
+    def load(cls) -> Optional['Config']:
+        if not os.path.exists(CONFIG_FILE):
+            return None
+
+        try:
+            with open(CONFIG_FILE, 'r') as f:
+                data = json.load(f)
+                return cls(
+                    registry_url=data.get("registry_url", DEFAULT_CONFIG["registry_url"]),
+                    output=data.get("output", DEFAULT_CONFIG["output"])
+                )
+        except (json.JSONDecodeError, IOError):
+            return None
+
+    def save(self):
+        data = {
+            "registry_url": self.registry_url,
+            "output": self.output
+        }
+        with open(CONFIG_FILE, 'w') as f:
+            json.dump(data, f, indent=2)
+
+    @classmethod
+    def init(cls) -> 'Config':
+        config = cls(
+            registry_url=DEFAULT_CONFIG["registry_url"],
+            output=DEFAULT_CONFIG["output"]
+        )
+        config.save()
+        return config
+
+    def get_template_path(self) -> Path:
+        return Path(self.output.get("templates", DEFAULT_CONFIG["output"]["templates"]))
+
+    def get_python_path(self) -> Path:
+        return Path(self.output.get("python", DEFAULT_CONFIG["output"]["python"]))

djinn_ui-0.1.0/djinn/core/installer.py

@@ -0,0 +1,52 @@
+import os
+from pathlib import Path
+from typing import List, Tuple
+from djinn.core.config import Config
+from djinn.core.registry import ComponentMetadata, Registry
+
+class Installer:
+    def __init__(self, config: Config, registry: Registry):
+        self.config = config
+        self.registry = registry
+
+    def install(self, component_name: str, force: bool = False) -> List[Tuple[str, Path]]:
+        metadata = self.registry.load_component(component_name)
+        if not metadata:
+            raise ValueError(f"Component '{component_name}' not found in registry.")
+
+        # Phase 1: Validation
+        files_to_install = []
+        for file_type, file_name in metadata.files.items():
+            if file_type == "template":
+                dest_base = Path(metadata.install.get("template_path", self.config.get_template_path()))
+            elif file_type == "python":
+                dest_base = Path(metadata.install.get("python_path", self.config.get_python_path()))
+            else:
+                dest_base = Path("components")
+
+            dest_path = dest_base / file_name
+
+            # Check if local file exists
+            if dest_path.exists() and not force:
+                raise FileExistsError(f"File '{dest_path}' already exists. Use --force to overwrite.")
+
+            # Relative path in registry
+            registry_file_path = self.registry.get_component_file_path(component_name, file_name)
+
+            files_to_install.append((file_type, registry_file_path, dest_path))
+
+        # Phase 2: Installation
+        installed_files = []
+        for file_type, registry_file_path, dest_path in files_to_install:
+            try:
+                content = self.registry.fetch_content(registry_file_path)
+            except FileNotFoundError:
+                 raise FileNotFoundError(f"Source file '{registry_file_path}' not found in registry.")
+
+            dest_path.parent.mkdir(parents=True, exist_ok=True)
+            with open(dest_path, "wb") as f:
+                f.write(content)
+
+            installed_files.append((file_type, dest_path))
+
+        return installed_files