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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: django_tailwind_cli-2.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 bfdaf230c6122d2fda2a8e998c5e44c59549176c4762f164058b61ec4d17948a
MD5 93c6d98771e7ff0f358c6ae4b376ff66
BLAKE2b-256 acd16016416491555927ee449598985e0ec9a7ef5492c7fb3cc1685cfe51bcd5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_tailwind_cli-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0f098e9f7b193d1a24f364a374c22ca79a117d2ff1247113ce38161ca903e0a9
MD5 b0c9060f93ce0885b11372c5b6017cae
BLAKE2b-256 0877f7bfa549f7c1b5136440e10c383b47c6ddc2ea8db1224004622d3fb3c1b2

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