Skip to main content

Django and Tailwind integration based on the prebuilt Tailwind CSS CLI.

Project description

django-tailwind-cli

GitHub Workflow Status PyPI Ruff uv GitHub Django Versions Python Versions Downloads Downloads / Month

[!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 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

  1. Install the library.

    python -m pip install django-tailwind-cli
    
  2. Add django_tailwind_cli to INSTALLED_APPS in settings.py.

    INSTALLED_APPS = [
        # other Django apps
        "django_tailwind_cli",
    ]
    
  3. Configure the STATICFILES_DIRS parameter in your settings.py if not already configured.

    STATICFILES_DIRS = [BASE_DIR / "assets"]
    
  4. Add template code.

    {% load tailwind_cli %}
    ...
    <head>
      ...
      {% tailwind_css %}
      ...
    </head>
    
  5. 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.

  • Support Tailwind CSS 4.x.

  • Proper support for DaisyUI via tailwindcss-cli-extra. Settings are described in the usage guide.

  • 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/

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_tailwind_cli-4.2.4.tar.gz (68.1 kB view details)

Uploaded Source

Built Distribution

django_tailwind_cli-4.2.4-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

Details for the file django_tailwind_cli-4.2.4.tar.gz.

File metadata

  • Download URL: django_tailwind_cli-4.2.4.tar.gz
  • Upload date:
  • Size: 68.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for django_tailwind_cli-4.2.4.tar.gz
Algorithm Hash digest
SHA256 023072bdc956c6b171c75eaa9950a5730f9107cfabd72922985ff345238335fb
MD5 71d6090c286e2a80a96400ecb09835b0
BLAKE2b-256 f80078a9688303f5d11551084b2bacb445af7503ecc87936d6ef300df1f45a55

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_tailwind_cli-4.2.4.tar.gz:

Publisher: release.yml on django-commons/django-tailwind-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file django_tailwind_cli-4.2.4-py3-none-any.whl.

File metadata

File hashes

Hashes for django_tailwind_cli-4.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5857e6e664fbbc1b266889894057b131ff8617e48e8666a219563245170a72e2
MD5 5fd35ece21f129205eaefe4d22d79c20
BLAKE2b-256 7497061fbc27d5a06878dd2b9ce8f67d63579b14bf8858e5354ad698fff5a33b

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_tailwind_cli-4.2.4-py3-none-any.whl:

Publisher: release.yml on django-commons/django-tailwind-cli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page