Skip to main content

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

Project description

django-tailwind-cli

GitHub Workflow Status PyPI Code style: black GitHub poetry-managed

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!

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.

Documentation

The documentation can be found at https://django-tailwind-cli.andrich.me/

Requirements

Python 3.9 or newer with Django >= 3.2.

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

Uploaded Source

Built Distribution

django_tailwind_cli-2.0.2-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django_tailwind_cli-2.0.2.tar.gz
  • Upload date:
  • Size: 8.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.11.4 Linux/5.15.0-1041-azure

File hashes

Hashes for django_tailwind_cli-2.0.2.tar.gz
Algorithm Hash digest
SHA256 f59ce4bfafdd8d068e8b3996cf3daf0dedd90079f553e552c0baf9e63ec6b6c3
MD5 00aec32b76ae2db77437ac70e8e8e393
BLAKE2b-256 7f391bb8d6d90faa97d6af92577a82733674f26006d87527a6df8a27276bfad4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_tailwind_cli-2.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8f453c3658d7901f3ba043c545370faf89acaf32e88a98fe7b71ad6e0ac1395b
MD5 195d05410ce0bc4aa7707dd285d763a2
BLAKE2b-256 90decc7e448959fc3e6b4ef90d95d8cf99889b1f8257db58cf9be3a68f69e11d

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 Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page