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

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for cunla from gravatar.com cunla Avatar for oliverandrich from gravatar.com oliverandrich Avatar for stormheg from gravatar.com stormheg
Meta

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT License Copyright (c) 2022 Oliver Andrich Permission is hereby granted, free of charge, to any...)
  • Tags css, django, tailwind
  • Requires: Python >=3.9
  • Provides-Extra: django-extensions
Classifiers

Project description

django-tailwind-cli

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

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.

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

  • A sane tailwind.config.js that activates all the official plugins and includes a simple HTMX plugin.

  • A management command to install a workaround to support Tailwind CLI in PyCharm.

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

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for cunla from gravatar.com cunla Avatar for oliverandrich from gravatar.com oliverandrich Avatar for stormheg from gravatar.com stormheg
Meta

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT License Copyright (c) 2022 Oliver Andrich Permission is hereby granted, free of charge, to any...)
  • Tags css, django, tailwind
  • Requires: Python >=3.9
  • Provides-Extra: django-extensions
Classifiers

Release history Release notifications | RSS feed

This version

2.21.1

2.21.0

2.20.2

2.20.1

2.20.0 yanked

Reason this release was yanked:

Contains a bug that makes this version useless.

2.19.3

2.19.2

2.19.1

2.19.0

2.18.1

2.18.0

2.17.0

2.16.0

2.15.0

2.14.0

2.13.0

2.12.0

2.11.1

2.11.0

2.10.0

2.9.0

2.8.1

2.8.0

2.7.3

2.7.2

2.7.0

2.6.0

2.4.5

2.4.4

2.4.3

2.4.2

2.4.1

2.4.0

2.3.0

2.2.3

2.2.2

2.2.0

2.1.1

2.1.0

2.0.6

2.0.5

2.0.4

2.0.2

2.0.1

1.4.3

1.4.2

1.4.1

1.3.1

1.3.0

1.2.2

1.2.1

1.2.0

1.1.1

1.1.0

1.0.1

0.9.2

0.9.1

0.9.0

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-2.21.1.tar.gz (66.5 kB view details)

Uploaded Source

Built Distribution

django_tailwind_cli-2.21.1-py3-none-any.whl (12.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for django_tailwind_cli-2.21.1.tar.gz
Algorithm Hash digest
SHA256 181f69dc172f50914823632dfec6d1d4d52150fcde4358b7439da37da025110b
MD5 bc901361c844f2a9e7f4988d65153b10
BLAKE2b-256 4b54f242a4052aa620920e53fa5351af0b095d98e75d4f921a676fd6a43f35bb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_tailwind_cli-2.21.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5e6df422341844ce3dd76bab3e63bbd74f760e71c3df1005792be23066e78257
MD5 d08a21e3cf137240b91c68a073d7d25d
BLAKE2b-256 fb503cfd29be03ea1abdc64121aff1e30182b6e9b06524e29661c112652b129a

See more details on using hashes here.

Supported by

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