Metadata-Version: 2.4
Name: render_engine_tailwindcss
Version: 2025.11.1
Summary: tailwindcss-parser for Render Engine
Project-URL: homepage, https://github.com/kjaymiller/render_engine_tailwindcss/
Project-URL: repository, https://github.com/kjaymiller/render_engine_tailwindcss/
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: render-engine[cli]>=2024.11.2a1
Requires-Dist: pytailwindcss
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Dynamic: license-file

# Render Engine TailwindCSS Plugin

Add tailwindcss to your Render Engine site.

[TailwindCSS](https://tailwindcss.com) is a utility-first CSS framework for rapidly building custom designs.

The [pytailwindcss](https://pypi.org/project/pytailwindcss/) package is used to install compile the tailwindcss stylesheets without the need of npm.

This plugin installs builds a tailwindcss file from the default configuration and adds a `tailwind.css` file to your static files.

> ***Warning***: This is in early development.

## Installation

Install the extension with pip:

    pip install render-engine-tailwindcss

## Usage

1. Import the plugin.

    ```python
    # app.py

    from render_engine import Site
    from render_engine_tailwindcss import TailwindCSS
    ```

2. Add the plugin to your site.

    ```python
    # app.py

    class site(Site):

        static_path = 'static'
        plugins=[
            TailwindCSS(),
        ]

    )
    ```

3. In your 'static_path', add your pre-tailwindcss stylesheets.

    ```css
    # static/styles.css

    @tailwind base;
    @tailwind components;
    @tailwind utilities; 
    ```

You can add multiple CSS files to the static path and they will all converted into their own files.

## Development & Testing

This project uses `just` for common development tasks and `nox` for testing across multiple Python versions.

### Quick Start with Just

```bash
# Run tests
just test

# Run tests with coverage
just test-coverage

# Run both (if available)
just check
```

### Using Nox for Multi-Version Testing

Test the plugin across Python 3.11, 3.12, 3.13, and 3.14:

```bash
# Run tests on all Python versions
nox -s test

# Run all checks
nox -s check
```

### Development Setup

```bash
# Install with uv (recommended)
uv sync

# Install with pip
pip install -e ".[test]"

# Run tests
just test
```

## Available Just Commands

- `just test` - Run pytest on current Python version
- `just test-coverage` - Run pytest with coverage reporting
- `just check` - Run tests
