https://github.com/django-commons/django-tailwind-cli
Django and Tailwind integration based on the prebuilt Tailwind CSS CLI.
https://github.com/django-commons/django-tailwind-cli
django django-application python tailwind tailwind-css tailwindcss
Last synced: about 2 months ago
JSON representation
Django and Tailwind integration based on the prebuilt Tailwind CSS CLI.
- Host: GitHub
- URL: https://github.com/django-commons/django-tailwind-cli
- Owner: django-commons
- License: mit
- Created: 2022-10-23T16:09:40.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-07T16:57:00.000Z (2 months ago)
- Last Synced: 2025-04-12T03:45:30.470Z (about 2 months ago)
- Topics: django, django-application, python, tailwind, tailwind-css, tailwindcss
- Language: Python
- Homepage: https://django-tailwind-cli.rtfd.io/
- Size: 1.31 MB
- Stars: 134
- Watchers: 5
- Forks: 16
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# django-tailwind-cli
[](https://pypi.org/project/django-tailwind-cli/)
[](https://github.com/astral-sh/ruff)
[](https://github.com/astral-sh/uv)
[](https://pepy.tech/project/django-tailwind-cli)
[]()
> [!WARNING]
> Version 4.2.x and onward only support Tailwind CSS 4.x. If you are using Tailwind CSS 3.x,
> please use version 2.21.1 of this library. Version 4.0.x or 4.1.x still support Tailwind CSS 3.x, but
> these versions are not recommended to use for new projects.
This library provides an integration of [Tailwind CSS](https://tailwindcss.com) for Django that is using on the precompiled versions of the [Tailwind CSS CLI](https://tailwindcss.com/blog/standalone-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](https://github.com/phoenixframework/tailwind) which completely skips the neccesity of a node installation.
## Installation
1. Install the library.
```shell
python -m pip install django-tailwind-cli
```
2. Add `django_tailwind_cli` to `INSTALLED_APPS` in `settings.py`.
```python
INSTALLED_APPS = [
# other Django apps
"django_tailwind_cli",
]
```
3. Configure the `STATICFILES_DIRS` parameter in your `settings.py` if not already configured.
```python
STATICFILES_DIRS = [BASE_DIR / "assets"]
```
4. Add template code.
```htmldjango
{% load tailwind_cli %}
...
...
{% tailwind_css %}
...
```
5. Start the debug server.
```shell
python manage.py tailwind runserver
```
Enjoy!
Checkout the detailed [installation guide](https://django-tailwind-cli.rtfd.io/latest/installation/)
if you want to activate browser reload or the `runserver_plus` management command known from
`django-extensions`.
## Features
- Simplest possible integration.
- Support Tailwind CSS 4.x.
- Proper support for DaisyUI via [tailwindcss-cli-extra](https://github.com/dobicinaitis/tailwind-cli-extra). Settings are described in the [usage guide](https://django-tailwind-cli.readthedocs.io/latest/usage/#use-with-daisyui).
- Or bring your own version of Tailwind CSS CLI.
- 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.
- Configuration options 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.
- Sane default configurations for Tailwinc 4.x.
## Requirements
Python 3.9 or newer with Django >= 4.0.
## Documentation
The documentation can be found at [https://django-tailwind-cli.rtfd.io/](https://django-tailwind-cli.rtfd.io/)
## Contributing
This package requires [uv](https://docs.astral.sh/uv/) for dependency management and tooling. So you
have to [install it](https://docs.astral.sh/uv/getting-started/installation/) first.
[just](https://github.com/casey/just) is used as a handy command runner to save some typing on the
command line. Do yourself a favor and install it too.
```shell
# 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
```bash
# 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](https://github.com/django-commons/django-tailwind-cli/blob/main/LICENSE).