labbdocs 0.0.1a0__tar.gz

labbdocs-0.0.1a0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Zadiq Oguntimehin
+
+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.

labbdocs-0.0.1a0/PKG-INFO

@@ -0,0 +1,111 @@
+Metadata-Version: 2.4
+Name: labbdocs
+Version: 0.0.1a0
+Summary: Documentation for the labb project
+License: MIT
+License-File: LICENSE
+Keywords: django,ui,components,library,perfect,django-cotton,tailwind,daisyui
+Author: zadiq
+Author-email: dev@zadiq.com
+Requires-Python: >=3.9,<4
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Framework :: Django
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Requires-Dist: django (>=4.2)
+Requires-Dist: markdown (>=3.9,<4.0)
+Requires-Dist: python-frontmatter (>=1.1.0,<2.0.0)
+Requires-Dist: pyyaml (>=6.0.3,<7.0.0)
+Project-URL: Documentation, https://labb.io/docs
+Project-URL: Discussions, https://github.com/labbhq/labb/discussions
+Project-URL: Source, https://github.com/labbhq/labb/tree/main/docs
+Description-Content-Type: text/markdown
+
+# labbdocs
+
+The documentation is available online at [https://labb.io/docs](https://labb.io/docs).
+
+This documentation is installed as a django app in the django project that powers the [labb.io](https://labb.io) website.
+
+## Installation
+
+```bash
+pip install labbdocs
+```
+
+## Integration with a django site
+
+### 1. Add to INSTALLED_APPS
+
+Add `labbdocs` to your Django project's `INSTALLED_APPS`:
+
+```python
+# settings.py
+INSTALLED_APPS = [
+    # ... other apps
+    'labbdocs',
+]
+```
+
+### 2. Configure LABB_DOCS
+
+Set up your documentation configuration in your Django settings:
+
+```python
+# settings.py
+LABB_DOCS = {
+    "ui": {
+        "config": "/path/to/your/ui.yaml",
+        "title": "UI Components",
+        "name": "ui",
+        "url_prefix": "/docs/ui",
+        "template_dir": "labbdocs/docs/ui/",
+        "build_path": "/path/to/templates/build/docs/ui"
+    },
+    "icons": {
+        "config": "/path/to/your/icons.yaml",
+        "title": "Icon Library",
+        "name": "icons",
+        "url_prefix": "/docs/icons",
+        "template_dir": "labbdocs/docs/icons/",
+        "build_path": "/path/to/templates/build/docs/icons"
+    }
+}
+```
+
+### 3. Include URLs
+
+Add labbdocs URLs to your main URL configuration:
+
+```python
+# urls.py
+from django.urls import path, include
+
+urlpatterns = [
+    # ... other patterns
+    path("", include("labbdocs.urls")),
+]
+```
+
+### 4. Build Documentation
+
+Use the management command to build your documentation:
+
+```bash
+# Build all documentation
+python manage.py build_docs ui
+python manage.py build_docs icons
+
+# Or build with quiet output
+python manage.py build_docs ui --quiet
+```
+

labbdocs-0.0.1a0/README.md

@@ -0,0 +1,78 @@
+# labbdocs
+
+The documentation is available online at [https://labb.io/docs](https://labb.io/docs).
+
+This documentation is installed as a django app in the django project that powers the [labb.io](https://labb.io) website.
+
+## Installation
+
+```bash
+pip install labbdocs
+```
+
+## Integration with a django site
+
+### 1. Add to INSTALLED_APPS
+
+Add `labbdocs` to your Django project's `INSTALLED_APPS`:
+
+```python
+# settings.py
+INSTALLED_APPS = [
+    # ... other apps
+    'labbdocs',
+]
+```
+
+### 2. Configure LABB_DOCS
+
+Set up your documentation configuration in your Django settings:
+
+```python
+# settings.py
+LABB_DOCS = {
+    "ui": {
+        "config": "/path/to/your/ui.yaml",
+        "title": "UI Components",
+        "name": "ui",
+        "url_prefix": "/docs/ui",
+        "template_dir": "labbdocs/docs/ui/",
+        "build_path": "/path/to/templates/build/docs/ui"
+    },
+    "icons": {
+        "config": "/path/to/your/icons.yaml",
+        "title": "Icon Library",
+        "name": "icons",
+        "url_prefix": "/docs/icons",
+        "template_dir": "labbdocs/docs/icons/",
+        "build_path": "/path/to/templates/build/docs/icons"
+    }
+}
+```
+
+### 3. Include URLs
+
+Add labbdocs URLs to your main URL configuration:
+
+```python
+# urls.py
+from django.urls import path, include
+
+urlpatterns = [
+    # ... other patterns
+    path("", include("labbdocs.urls")),
+]
+```
+
+### 4. Build Documentation
+
+Use the management command to build your documentation:
+
+```bash
+# Build all documentation
+python manage.py build_docs ui
+python manage.py build_docs icons
+
+# Or build with quiet output
+python manage.py build_docs ui --quiet
+```

labbdocs-0.0.1a0/labbdocs/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.0.1a"

labbdocs-0.0.1a0/labbdocs/apps.py

@@ -0,0 +1,7 @@
+from django.apps import AppConfig
+
+
+class LabbDocsConfig(AppConfig):
+    default_auto_field = "django.db.models.BigAutoField"
+    name = "labbdocs"
+    verbose_name = "Labb Documentation"

labbdocs-0.0.1a0/labbdocs/content/icons/1_getting_started/1_introduction.md

@@ -0,0 +1,28 @@
+---
+title: Introduction
+description: Beautiful, accessible, and customizable icon components for your Django projects.
+doc_show_toc: False
+---
+
+<c-lbdocs.component_example path="introduction/welcome-card" style="stacked" />
+
+The labb Icons library provides a comprehensive set of reusable icon components that integrate seamlessly with Django Cotton. Whether you need simple interface icons or complex illustrations, these components will help you create consistent, professional designs quickly.
+
+labb Icons allow you to use icons with familiar HTML tag structure. Instead of complex SVG markup or external icon libraries, you can use simple, intuitive component tags that look and feel like regular HTML elements. This makes your templates more readable and maintainable while providing powerful functionality under the hood.
+
+All icons are rendered on the backend, ensuring fast page loads and excellent SEO. Icons work without JavaScript by default, making them accessible and performant out of the box.
+
+## What is labb Icons?
+
+labb Icons is a Django icon component library that provides beautiful, accessible, and customizable icon components. Built on top of Django Cotton and integrated with popular icon sets like Remix Icons, it offers a modern approach to using icons in Django projects.
+
+## Key Features
+
+- **Django Cotton Integration**: Icons are built using Django Cotton for seamless template composition and reusability.
+- **Multiple Icon Packs**: Support for popular icon sets like Remix Icons, with more packs coming soon.
+- **Fill & Line Variants**: Most icons support both filled and outlined variants for design flexibility.
+- **No JavaScript Required**: Icons work without JavaScript, ensuring accessibility and performance.
+- **Backend Rendered**: All icon components are rendered on the server for fast page loads and better SEO.
+- **Customizable**: Easy sizing and styling through CSS classes and attributes.
+- **Smart Defaults**: Line variants are the default, with easy switching to fill variants.
+- **AI and LLM Friendly**: Accessible documentation and code examples for AI and LLM use cases.

labbdocs-0.0.1a0/labbdocs/content/icons/1_getting_started/2_installation.md

@@ -0,0 +1,71 @@
+---
+title: Installation
+description: Learn how to install and set up labb Icons in your Django project.
+
+---
+
+{% load docs_tags %}
+
+
+
+## Install labb Icons
+
+### Using pip
+
+```bash
+pip install labbicons
+# or both labbui and labbicons
+pip install labbui[icons]
+```
+
+### Using Poetry
+
+```bash
+poetry add labbicons
+# or both labbui and labbicons
+poetry add labbui[icons]
+```
+
+## Add to Django Settings
+
+Add `labbicons` to your `INSTALLED_APPS`:
+
+```python
+INSTALLED_APPS = [
+    # ... other apps
+    'django_cotton',
+    # 'labb',  # optional, add if you are using the labb components
+    'labbicons',
+]
+```
+
+> **Note**: labb Icons only requires the `django-cotton` package and can be used independently of the labb UI components in any Django project. If you have already installed `labb`, you would have already <a href="{% doc_url '1_getting_started/2_installation.md' 'ui' %}#add-to-django-settings">added</a> `django_cotton`.
+
+## Basic Usage
+
+Once installed, you can start using icons in your templates:
+
+```html
+<!-- Basic usage -->
+<c-lbi.rmx.heart w="24" h="24" class="text-red-500" />
+
+<!-- Fill variant -->
+<c-lbi.rmx.heart w="24" h="24" class="text-red-500" fill />
+```
+
+## CLI Commands
+
+Use the `labb icons` command to search and manage icons:
+
+```bash
+# Search for icons
+labb icons search "arrow"
+
+# List available packs
+labb icons packs
+
+# Get detailed icon information
+labb icons info rmx.arrow-down
+```
+
+For complete CLI documentation, see the <a href="{% doc_url '2_references/0_labb_cli.md' 'ui' %}#labb-icons">labb icons command reference</a>.

labbdocs-0.0.1a0/labbdocs/content/icons/1_getting_started/3_quick_start.md

@@ -0,0 +1,125 @@
+---
+title: Quick Start
+description: Get started with labb Icons in minutes
+---
+
+{% load docs_tags %}
+
+## Basic Usage
+
+After installing labb Icons, you can start using icons immediately. Icons can be referenced in two ways:
+
+### 1. Direct Component Syntax
+```html
+<!-- Using the pattern <c-lbi.<pack>.<icon> /> -->
+<c-lbi.rmx.heart w="24" h="24" class="text-red-500" />
+<c-lbi.rmx.arrow-down-box w="24" h="24" />
+```
+
+### 2. Name Attribute Syntax
+```html
+<!-- Using the n attribute -->
+<c-lbi n="rmx.heart" w="24" h="24" class="text-red-500" />
+<c-lbi n="rmx.arrow-down-box" w="24" h="24" />
+```
+
+
+### 3. In Components (if supported)
+Some labb components support an `icon` parameter:
+
+```html
+<!-- Badge with integrated icon -->
+<c-lb.badge variant="info" icon="rmx.information">Info</c-lb.badge>
+
+<!-- Button with icon -->
+<c-lb.button variant="primary" icon="rmx.save">Save</c-lb.button>
+```
+
+## Icon Packs
+
+labb Icons supports multiple icon packs. Currently available:
+
+- **Remix Icons (rmx)**: 1600+ icons across 19 categories
+- More packs coming soon!
+
+Use the CLI to explore available packs:
+
+```bash
+# List all available packs
+labb icons packs
+
+# Search for icons across all packs
+labb icons search "arrow"
+```
+
+## Icon Variants
+
+Most icons come in two variants - line (outlined) and fill (solid):
+
+```html
+<!-- Line variant (default) -->
+<c-lbi.rmx.camera w="24" h="24" class="text-blue-500" />
+
+<!-- Fill variant -->
+<c-lbi.rmx.camera w="24" h="24" class="text-blue-500" fill />
+
+<!-- Line variant (explicit) -->
+<c-lbi.rmx.camera w="24" h="24" class="text-blue-500" line />
+```
+
+## Customizing Icons
+
+### Size
+
+Control the size of your icons using the `w` (width) and `h` (height) attributes:
+
+```html
+<!-- Small icon -->
+<c-lbi.rmx.heart w="16" h="16" class="text-red-500" />
+
+<!-- Large icon -->
+<c-lbi.rmx.heart w="32" h="32" class="text-red-500" />
+
+<!-- Using em units -->
+<c-lbi.rmx.heart w="1em" h="1em" class="text-red-500" />
+
+<!-- Using pixel units -->
+<c-lbi.rmx.heart w="2px" h="2px" class="text-red-500" />
+
+<!-- Different width and height -->
+<c-lbi.rmx.heart w="20" h="24" class="text-red-500" />
+```
+
+### Styling
+
+Apply CSS classes to style your icons:
+
+```html
+<!-- Basic styling -->
+<c-lbi.rmx.heart w="24" h="24" class="text-red-500" />
+
+<!-- With hover effects -->
+<c-lbi.rmx.heart w="24" h="24" class="text-red-500 hover:text-red-700 transition-colors" />
+
+<!-- With custom classes -->
+<c-lbi.rmx.heart w="24" h="24" class="text-red-500 my-custom-icon-class" />
+```
+
+
+## CLI Commands
+
+The `labbicons` CLI is available by default. When using `labb`, you can access it under `labb icons`:
+
+```bash
+# Using labbicons directly
+labbicons search "arrow"
+labbicons info rmx.arrow-down
+labbicons packs
+
+# Using through labb (if labb is installed)
+labb icons search "arrow"
+labb icons info rmx.arrow-down
+labb icons packs
+```
+
+For complete CLI documentation, see the <a href="{% doc_url '2_references/0_labb_cli.md' 'ui' %}#labb-icons">labb icons command reference</a>.

labbdocs-0.0.1a0/labbdocs/content/icons/2_packs/1_remix.md

@@ -0,0 +1,14 @@
+---
+doc_layout: component
+component: c-lbi.rmx
+title: Remix
+description: Open-source neutral-style system symbols elaborately crafted for designers and developers.
+doc_show_toc: false
+doc_links:
+    - url: https://remixicon.com/
+      type: external
+      icon: rmx.remixicon
+---
+
+
+<c-lbdocs.icon_browser />

labbdocs-0.0.1a0/labbdocs/content/icons/2_packs/more.md

@@ -0,0 +1 @@
+More packs coming soon!

labbdocs-0.0.1a0/labbdocs/content/icons/index.md

@@ -0,0 +1,4 @@
+<!-- Grid layout of links -->
+Installation
+
+Remix

labbdocs-0.0.1a0/labbdocs/content/ui/1_getting_started/1_introduction.md

@@ -0,0 +1,27 @@
+---
+title: Introduction
+description: Beautiful, accessible, and customizable UI components for your Django projects.
+doc_show_toc: False
+---
+
+<c-lbdocs.component_example path="introduction/welcome-card" style="stacked" />
+
+The labb Component library provides a comprehensive set of reusable components that combine the power of [Django Cotton](https://django-cotton.com/) with the beautiful styling of [daisyUI 5](https://daisyui.com/docs/intro/). Whether you're building a simple form or a complex dashboard, these components will help you create consistent, professional interfaces quickly.
+
+labb components allow you to write templates using familiar HTML tag structure. Instead of complex template tags or verbose syntax, you can use simple, intuitive component tags that look and feel like regular HTML elements. This makes your templates more readable and maintainable while providing powerful functionality under the hood.
+
+All template tags are rendered on the backend, ensuring fast page loads and excellent SEO. Components work without JavaScript by default, making them accessible and performant out of the box.
+
+## What is labb Component?
+
+labb Component is a Django component library that provides beautiful, accessible, and customizable UI components. Built on top of Django Cotton and styled with Tailwind CSS and daisyUI 5, it offers a modern approach to building Django frontends.
+
+## Key Features
+
+- **Django Cotton Integration**: Components are built using Django Cotton for seamless template composition and reusability. Use familiar HTML tags and attributes to build your components.
+- **daisyUI 5 Styling**: Beautiful, consistent styling powered by daisyUI 5 and Tailwind CSS.
+- **No JavaScript by Default**: Components work without JavaScript, ensuring accessibility and performance.
+- **Backend Rendered**: All template tags are rendered on the server for fast page loads and better SEO.
+- **Customizable**: Easy theming and customization through Tailwind 4 CSS variables.
+- **CLI Tool**: Built-in CLI for project setup, component inspection, and development workflows.
+- **AI and LLM Friendly**: accessible documentation and code examples for AI and LLM use cases.

labbdocs-0.0.1a0/labbdocs/content/ui/1_getting_started/2_installation.md

@@ -0,0 +1,177 @@
+---
+title: Installation
+description: How to install and set up labb in your Django project
+---
+
+## Prerequisites
+
+Before installing labb, make sure you have:
+
+- Django 4.2 or higher
+- Python 3.8 or higher
+
+## Install labb
+
+### Using pip
+
+```bash
+pip install labbui
+```
+
+### Using Poetry
+
+```bash
+poetry add labbui
+```
+
+## Add to Django Settings
+
+Add `labb` to your `INSTALLED_APPS` in your Django settings:
+
+### Automatic configuration:
+
+<c-lbdocs.codeblock_title title="settings.py">
+```python
+INSTALLED_APPS = [
+    # ... other apps
+    'django_cotton',
+    'labb',
+]
+```
+</c-lbdocs.codeblock_title>
+
+This will attempt to automatically handle the settings.py by adding the required loader and templatetags.
+
+### Custom configuration
+
+If your project requires any non-default loaders or you do not wish Cotton to manage your settings, you should instead provide `django_cotton.apps.SimpleAppConfig` in your INSTALLED_APPS:
+
+<c-lbdocs.codeblock_title title="settings.py">
+```python
+INSTALLED_APPS = [
+    # ... other apps
+    'django_cotton.apps.SimpleAppConfig',
+    'labb',
+]
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': [BASE_DIR / 'templates'],
+        'APP_DIRS': False,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+            'loaders': [
+                (
+                    'django.template.loaders.cached.Loader',
+                    [
+                        'django_cotton.cotton_loader.Loader',
+                        'django.template.loaders.filesystem.Loader',
+                        'django.template.loaders.app_directories.Loader',
+                    ],
+                )
+            ],
+            'builtins': [
+                'django_cotton.templatetags.cotton',
+            ],
+        },
+    },
+]
+```
+</c-lbdocs.codeblock_title>
+
+## Initialize labb Project
+
+After adding labb to your Django settings, you need to initialize and set up labb in your project:
+
+### Step 1: Initialize Project
+
+Initialize labb project with configuration and project structure:
+
+```bash
+labb init
+```
+
+For quick setup with defaults:
+
+```bash
+labb init --defaults
+```
+
+**Init Options:**
+
+```bash
+# Force overwrite existing files created by labb init
+labb init --force
+```
+### Step 2: Install Dependencies
+
+Install the required Node.js dependencies:
+
+```bash
+labb setup
+```
+
+**Setup Options:**
+
+```bash
+# Install dependencies automatically
+labb setup --install-deps
+
+# Skip dependency installation
+labb setup --no-install-deps
+```
+
+## Basic Usage
+
+Once installed and setup, you can start using components in your templates.
+
+First, start the labb development watcher to monitor changes and build CSS:
+
+```bash
+labb dev
+```
+
+This will start both CSS building and template scanning in watch mode. Keep this running while you develop.
+
+Next, in a **separate terminal**, start your Django development server:
+
+```bash
+python manage.py runserver
+```
+
+Now you can create templates with labb components:
+
+<c-lbdocs.codeblock_title title="templates/example.html">
+{% verbatim %}
+```html
+<!DOCTYPE html>
+<html lang="en" {% labb_theme %}>
+<head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>My labb App</title>
+
+    <c-lb.m.dependencies />
+</head>
+<body>
+    <!-- Basic button -->
+    <c-lb.button variant="primary">Click me</c-lb.button>
+
+    <!-- Card component -->
+    <c-lb.card>
+      <c-lb.card.body>
+        <c-lb.card.title>Card Title</c-lb.card.title>
+        <p>Card content goes here</p>
+      </c-lb.card.body>
+    </c-lb.card>
+</body>
+</html>
+```
+{% endverbatim %}
+</c-lbdocs.codeblock_title>