Django and Tailwind integration based on the prebuilt Tailwind CSS CLI.
Project description
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.
python -m pip install django-tailwind-cli
-
Add
django_tailwind_clitoINSTALLED_APPSinsettings.py.INSTALLED_APPS = [ # other Django apps "django_tailwind_cli", ]
-
Configure the
STATICFILES_DIRSparameter in yoursettings.pyif not already configured.STATICFILES_DIRS = [BASE_DIR / "assets"]
-
Add template code.
{% load tailwind_cli %} ... <head> ... {% tailwind_css %} ... </head>
-
Start the debug server.
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 >= 3.2.
Documentation
The documentation can be found at https://django-tailwind-cli.andrich.me/
Contributing
In order to contribute, this package has no required tool dependencies besides an installed version of Python and pip. But you can use uv to speed up your workflow a bit. The following commands assume that you have already setup a virtual environment and activated it.
# 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 pip
# Install dependencies
pip3 install -e ".[django-extensions,dev,docs]"
# Run nox testrunner
nox
Without just, but using uv
# Install dependencies
uv pip install -r pyproject.toml --all-extras -e .
# Run nox testrunner
nox --force-venv-backend uv
License
This software is licensed under MIT license.
Release history Release notifications | RSS feed
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
File details
Details for the file django_tailwind_cli-2.12.0.tar.gz.
File metadata
- Download URL: django_tailwind_cli-2.12.0.tar.gz
- Upload date:
- Size: 24.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.31.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | defdda15832488127e092fd2119f734ace267131c714f46fd1a333448318e781 |
|
| MD5 | 1333e2cce7810cfa617d77ff37516b8c |
|
| BLAKE2b-256 | 631d226075bed284b5c5f0a60044a4078c38a051a40958fdc2dcf63341cc04f8 |
File details
Details for the file django_tailwind_cli-2.12.0-py3-none-any.whl.
File metadata
- Download URL: django_tailwind_cli-2.12.0-py3-none-any.whl
- Upload date:
- Size: 10.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-requests/2.31.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 68622807e3169c7c0b63a7e338f33030370b21888a9138e07b2ed879191a5803 |
|
| MD5 | 45a2fa2eeb61da63af3ecb4d85109ec9 |
|
| BLAKE2b-256 | 8819af59bdd89d4ab3472e8cbac2df8de40e712d2d876eebe7d0a1016af9aa85 |
