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 Hatch project

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.

Requirements

Python 3.8 or newer with Django >= 3.2.

Documentation

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

Contributing

If you want to contribute to this project, checkout the development guide for details to get your dev environment up and running.

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

Uploaded Source

Built Distribution

django_tailwind_cli-2.1.1-py3-none-any.whl (9.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django_tailwind_cli-2.1.1.tar.gz
  • Upload date:
  • Size: 17.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.24.1

File hashes

Hashes for django_tailwind_cli-2.1.1.tar.gz
Algorithm Hash digest
SHA256 6ce73cef3edde1589ee65b3c0e2331dbb62bc81abecd8a7367803d3f398561a2
MD5 4776e1359f4bf6ce9d260009c4c8a664
BLAKE2b-256 8a33f40d46ae4235e93ff83e2b2fa5d680891e81019e0c8ac59057bba4a00753

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_tailwind_cli-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fbf3624f4a009d793283645439c5b75e35f7b2bb1bce9794328e029c481d70f9
MD5 5a49f3fa2a590b94111610a0e333082a
BLAKE2b-256 00e541bbdcf4e851f2f36eb1019338dbde884f4d9b777e13a5382e754caf6e4c

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