Provides a CLI plugin for Litestar to use Tailwind CSS via the Tailwind CLI.
Project description
litestar-tailwind-cli
[!IMPORTANT] This plugin currently contains minimal features and is a work-in-progress
Provides a CLI plugin for Litestar to use Tailwind CSS via the Tailwind CLI.
Table of Contents
Installation
pip install litestar-tailwind-cli
Usage
Configure and include the TailwindCLIPlugin in your Litestar app:
from pathlib import Path
from litestar import Litestar
from litestar.static_files import create_static_files_router
from litestar.contrib.jinja import JinjaTemplateEngine
from litestar.template.config import TemplateConfig
from litestar_tailwind_cli import TailwindCLIPlugin
ASSETS_DIR = Path("assets")
tailwind_cli = TailwindCLIPlugin(
use_server_lifespan=True,
src_css=ASSETS_DIR / "css" / "input.css",
dist_css=ASSETS_DIR / "css" / "tailwind.css",
)
app = Litestar(
route_handlers=[create_static_files_router(path="/static", directories=["assets"])],
debug=True,
plugins=[tailwind_cli],
template_config=TemplateConfig(
directory=Path("templates"),
engine=JinjaTemplateEngine,
),
)
<head>
...
<link rel="stylesheet" href="/static/css/tailwind.css">
</head>
After setting up, you can use the following commands:
litestar tailwind init: This command initializes the tailwind configuration and downloads the CLI if it's not already installed.litestar tailwind watch: This command starts the Tailwind CLI in watch mode during development. You won't have to use this if you setuse_server_lifespantoTrue.litestar tailwind build: This command builds a minified production-ready CSS file.
[!NOTE] Don't forget to update the
contentkey intailwind.config.jsto specify your templates directories.
The TailwindCLIPlugin has the following configuration options:
src_css: The path to the source CSS file. Defaults to "css/input.css".dist_css: The path to the distribution CSS file. Defaults to "css/tailwind.css".config_file: The path to the Tailwind configuration file. Defaults to "tailwind.config.js".use_server_lifespan: Whether to use server lifespan. Defaults toFalse. It will start the Tailwind CLI in watch mode when you use thelitestar runcommand.cli_version: The version of the Tailwind CLI to download. Defaults to "latest".src_repo: The GitHub repository from which to download the Tailwind CLI. Defaults totailwindlabs/tailwindcss.asset_name: The name of the asset to download from the repository. Defaults totailwindcss.
For example, if you are using the repository https://github.com/dobicinaitis/tailwind-cli-extra/tree/main, you would set src_repo to "dobicinaitis/tailwind-cli-extra" and asset_name to "tailwindcss-extra".
License
litestar-tailwind-cli is distributed under the terms of the MIT license.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for litestar_tailwind_cli-0.2.0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 972b0a21259ce8d176beaf07c46f8c10b5fbe2b7ca4c5aa92a7322b175f0f3b1 |
|
| MD5 | c6750a16527a35a0fd825105c2ed6f9c |
|
| BLAKE2b-256 | 80df12091f9c3dbba4a827fb419716fc2e13b4af6a285a34b7a98a6bcd1f56fe |
Hashes for litestar_tailwind_cli-0.2.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 486f168cf8b0fe95326f7c0ea41b284081f563a90cbfbcc0feff31ad83eb5515 |
|
| MD5 | b230eda757ad33e2fb5a2d2e4fd48480 |
|
| BLAKE2b-256 | a96b5d3a3d74fe8b15d06cf85ad029e7f4caf18a9a522111ad6fa1d56fce6bc7 |
