asok-lucide 1.0.0

Lucide Icons integration for the Asok framework.

+

asok-lucide

Lucide Icons integration for the Asok Framework.

Render beautiful Lucide Icons server-side with zero client-side JavaScript overhead.

Resources

• Asok Framework: asok-framework.com
• Asok Repository: github.com/asok-framework/asok
• Lucide Icons: lucide.dev

Installation

pip install asok-lucide

For development or contributing, install in editable mode:

pip install -e .

Setup

Register the extension in your app.py:

from asok import Asok
from asok_lucide import AsokLucideExtension

app = Asok()
app.register_extension(AsokLucideExtension)

You can optionally configure a custom alias (e.g. icon) to shorten the template helper name:

app.register_extension(AsokLucideExtension(alias="icon"))

Usage

Direct template helper

<button>
    {{ lucide("shopping-cart", class_="w-5 h-5 text-white") }}
    <span>Add to Cart</span>
</button>

Or using the custom alias (if registered):

{{ icon("user", class_="w-6 h-6") }}

Template filter

{{ "home" | lucide(class_="w-6 h-6", stroke_width="1.5") }}

All standard attributes (such as class, stroke-width, stroke, fill, style) can be customized dynamically. Use class_ or snake_case stroke_width in template helpers.

Development & Publishing

Updating the Icon Dataset

The icons are pre-compiled and bundled inside the package (asok_lucide/data/lucide-icons.json) to guarantee fast, deterministic server-side rendering without runtime network dependencies.

To update the bundled Lucide Icons (e.g., when a new Lucide version releases):

1. Run the update script to fetch and resolve all icon definitions & aliases from Iconify:

   python scripts/fetch_icons.py
   

2. Run the test suite to verify everything still renders correctly:

   python -m pytest tests
   

3. Commit the updated lucide-icons.json to Git.

Releases & GitHub Actions

A GitHub Actions workflow is configured in .github/workflows/release.yml. When you publish a release on GitHub:

1. The workflow checks out the repository (which contains the committed lucide-icons.json data).
2. It builds the wheel and source distributions.
3. It automatically publishes the package to PyPI using PyPI's Trusted Publishing OIDC integration.