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 project provides an integration of Tailwind CSS for Django that is based on the precompiled versions of the Tailwind CSS CLI.

It is inspired by the implementation of the Tailwind integration for Phoenix which completely skips the neccesity of a node installation. So it is a perfect match, if you are a user of htmx or any other framework that tries to avoid JavaScript coding in your web app. My personal motivation was, that I discovered that I never needed any other plugin besides the official plugins, which are already included in the CLI.

If you want to use node or you have to use it because of other dependencies, then the package django-tailwind by Tim Kamamin might be a better solution for you.

Features

  • Management Commands...
    • ...to install the the CLI for your operating system and machine architecture.
    • ...to start the CLI in watch mode to incrementally compile your style sheet.
    • ...to create a theme app which includes a basic stylesheet and a tailwind configuration which you can extend.
    • ...to build the production ready CSS file.
  • A template tag to include the CSS file in your base template.
  • All the official plugins (typography, form, line-clamp, container queries, and aspect-ratio) integrated in the CLI are activated in the default configuration.

Requirements

Python 3.8 or newer with Django >= 3.2.

Documentation

The documentation can be found at https://django-tailwind-cli.readthedocs.io.

Installation

python -m pip install django-tailwind-cli

Check the docs for detailed installation instructions.

Bugs and suggestions

In case you have found a bug or have a suggestion, please open a ticket at https://github.com/oliverandrich/django-tailwind-cli/issues.

License

This software is licensed under MIT license. Copyright (c) 2022 Oliver Andrich.

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-1.4.2.tar.gz (8.0 kB view hashes)

Uploaded Source

Built Distribution

django_tailwind_cli-1.4.2-py3-none-any.whl (9.2 kB view hashes)

Uploaded Python 3

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