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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: django_tailwind_cli-2.0.6.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.6.tar.gz
Algorithm Hash digest
SHA256 395b94c760076f1e37ff830ac208deb29f4b7733a09cfeb81cbbf50ce66f26ef
MD5 ec4964d542011ea43b5fd28bc67cb3e8
BLAKE2b-256 0f68796de36dd1a69c0ed0262cbe594441dc34aae1a2b75430558e94157f2170

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_tailwind_cli-2.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 96b06b9419bfb24e574701ee8988cd76f842611485d43ed015f7b25bf8e89338
MD5 9c203f3ac3b80ebc5feb37fc972d8908
BLAKE2b-256 975a6e844eda277f8bc7353732d165ac3e8ad3032955113c7af12a904d3333f7

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