Skip to main content

Vite build tools integration for django

Project description

Django Vite Plugin

PyPI version

Introduction

Vite is a modern frontend build tool that provides an extremely fast development environment and bundles your code for production.

This plugin configures Vite for use with Django backend.

Installation

pip install django_vite_plugin

Then in your projects settings.py file, add django_vite_plugin in installed apps

# Some settings
INSTALLED_APPS = [
    # Some apps
    'django_vite_plugin',
    # Other apps
]

These are the available configuration options

# Other settings
DJANGO_VITE_PLUGIN = {
    'WS_CLIENT': '@vite/client',
    'DEV_MODE': getattr(settings, 'DEBUG', True),
    'BUILD_DIR': getattr(settings, 'STATIC_ROOT') or 'static',
    'BUILD_URL_PREFIX': getattr(settings, 'STATIC_URL'), # Bundled assets would be prefixed with this on production
    'SERVER': {
        'HTTPS': False,
        'HOST': '127.0.0.1',
        'PORT': 5173
    },
    'JS_ATTRS': {
        'type': 'module'
    },
    'CSS_ATTRS': {
        'rel' : 'stylesheet',
        'type': 'text/css'
    },
    'STATIC_LOOKUP': True
}

See the official documentation for more details

Usage

<!--Your Template file-->
{% load vite %}
<!DOCTYPE html>
<html lang="en">
    <head>
        <!--Other elements-->
        <!--Vite dev client for hmr (will not be displayed on production)-->
        {% vite %}
        <!--These attributes will be present in both `asset1.css` & `asset2.js`-->
        {% vite 'asset1.css' 'asset2.js' someattr='value' %}
    </head>
    <body>
        <!--Page content-->
    </body>
</html>

Official Documentation

Documentation for the Django Vite plugin can be found on the Github.

License

The Django Vite plugin is open-sourced software licensed under the 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_vite_plugin-4.1.0.tar.gz (7.1 kB view details)

Uploaded Source

Built Distribution

django_vite_plugin-4.1.0-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file django_vite_plugin-4.1.0.tar.gz.

File metadata

  • Download URL: django_vite_plugin-4.1.0.tar.gz
  • Upload date:
  • Size: 7.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.2

File hashes

Hashes for django_vite_plugin-4.1.0.tar.gz
Algorithm Hash digest
SHA256 85f749c41be4191ab031d36e3ee47e4a2bf8d25222becb8f25515f3e688db61b
MD5 fa9e51a6f4e037ac55c71f5e17751266
BLAKE2b-256 19e7f6a461351095af67209d1b9653ee3382cc8b1d34cce810b4c4a53460a143

See more details on using hashes here.

File details

Details for the file django_vite_plugin-4.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for django_vite_plugin-4.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 834f979960d5d05b53c0c5a8f6143108c9c4ce56fda16a140f638ccd6607ed7c
MD5 8ceed69444c7e43fcd31d3dc9e7a69d1
BLAKE2b-256 ce43f5ee21f7a21f37fc66682549f47614ddcabf84be4a61661f61001a239a87

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page