django-tailwind-cli
This library provides an integration of Tailwind CSS for Django that is using on the precompiled versions of the Tailwind CSS CLI.
The goal of this library is to provided the simplest possible Tailwind integration for your Django project. It took its inspiration from the Tailwind integration for Phoenix which completely skips the neccesity of a node installation.
Installation
- Install the library.
shell
python -m pip install django-tailwind-cli
- Add
django_tailwind_cli
toINSTALLED_APPS
insettings.py
.
python
INSTALLED_APPS = [
# other Django apps
"django_tailwind_cli",
]
- Configure the
STATICFILES_DIRS
parameter in yoursettings.py
if not already configured.
python
STATICFILES_DIRS = [BASE_DIR / "assets"]
- Add template code.
htmldjango
{% load tailwind_cli %}
...
<head>
...
{% tailwind_css %}
...
</head>
- Start the debug server.
shell
python manage.py tailwind runserver
Enjoy!
Checkout the detailed installation guide if you want to activate browser reload or the runserver_plus
management command known from django-extensions
.
Features
- Simplest possible integration.
- Management commands:
- To start the Tailwind CLI in watch mode during development.
- To build the production grade CSS file for your project.
- To start a debug server along with the Tailwind CLI in watch mode in a single session.
- Necessary configuration to adapt the library to your project, when the defaults don't fit you.
- A template tag to include the Tailwind CSS file in your project.
- A base template for your project.
- A sane tailwind.config.js that activates all the official plugins and includes a simple HTMX plugin.
Requirements
Python 3.9 or newer with Django >= 4.2.
Documentation
The documentation can be found at https://django-tailwind-cli.rtfd.io/
Contributing
This package requires uv for dependency management and tooling. So you have to install it first. just is used as a handy command runner to save some typing on the command line. Do yourself a favor and install it too.
# Setup development environment
just bootstrap
# Upgrade/install all dependencies defined in pyproject.toml
just upgrade
# Run pre-commit rules on all files
just lint
# Run test suite
just test
Without just, but using uv
# Create venv
uv venv
# Install dependencies
uv sync --all-extras
# Run tox testrunner
uvx --with tox-uv tox
License
This software is licensed under MIT license.