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

Uploaded Source

Built Distribution

django_tailwind_cli-2.2.0-py3-none-any.whl (10.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for django_tailwind_cli-2.2.0.tar.gz
Algorithm Hash digest
SHA256 8539d84e95a98add993f97a1cb6b70415a43950fdb52ef86b70b7dbf39e7deb4
MD5 76806ddf5055a0c348ba986642fc5cc7
BLAKE2b-256 372e31f7535c735a90a6dc9bce777be3d43952d75ef7e88761c18e18e4915727

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_tailwind_cli-2.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 c79e4a3c9fbd40ef6a25b4f1bc2083f2ac1fd0d8c69c45d459dab635b5baa4cd
MD5 470b0ce64932bf040ae1f975a125e1fa
BLAKE2b-256 b58b75e55f3a9f8c5731ac0a378656ad098c9ca8349ce8b57fc1a081d8a6e984

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