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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for django_tailwind_cli-2.2.2.tar.gz
Algorithm Hash digest
SHA256 b3d1bbf4154fc9128155666995faddf40b8701baede8f6927201a6cdd1c73abe
MD5 35f1d7a74e2a18cbf6aa3d0660d89ec5
BLAKE2b-256 b1fd5ba29dbf14ce2236361d0038312dfea3b1456ced0e5a1963358a26430301

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_tailwind_cli-2.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 e8f92ed9300939b93b01da1b31f729654a140ee1099865a0aa8eb7b844262164
MD5 024183dafd16aaf7a294a56e5fdffcc4
BLAKE2b-256 b5bd98572fb98e6f235f558b1503935d0989cf0f2b2687550b038ee4a204bf85

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