Skip to main content

Django Vanillaframework

CI

Vanilla Framework frontend for Django

Requirements

Python 3.6 or newer, Django 3.2 or newer

Install

Using pip:

pip install django-vanillaframework

Setup

Add 'vanillaframework' to the INSTALLED_APPS list in your project settings

INSTALLED_APPS = [
    ...,
    'vanillaframework'
]

At this point, you can use Vanilla Framework in your Django templates, and the css will be pulled from assets.ubuntu.com

If you would like to use a local copy of the css file, run the install management command:

python3 manage.py vanillaframework -i --css

The vanillaframework_css tag will grab the local file from now on until it is deleted.

If you would like to customize Vanilla Framework settings, you can instead install the source sass files. Make sure npm is installed on your system before you begin.

Run the installer without the --css argument:

python3 manage.py vanillaframework -i

This will install the npm vanilla-framework package to the static folder alongside the file vanillaframework.scss. Use this file to customize the library.

Note: If you are using the sass version of Vanilla Framework, you will have to install django-compressor and a sass compiler such as django-libsass then update your settings file accordingly:

INSTALLED_APPS = [
    ...,
    'django.contrib.staticfiles',
    'vanillaframework',
    'compressor'
]

STATICFILES_FINDERS = (
    ...,
    'compressor.finders.CompressorFinder'
)

COMPRESS_PRECOMPILERS = (
    ('text/x-scss', 'django_libsass.SassCompiler'),
)

Usage

Once django-vanillaframework is set up, you can use it by including the relevant tags in a Django template.

For the css version, use vanillaframework_css:

{% load vanillaframework_tags %}

<html>
    <head>
        {% vanillaframework_css %}
    </head>
</html>

And for the sass version, use vanillaframework_sass:

{% load vanillaframework_tags %}

<html>
    <head>
        {% vanillaframework_sass %}
    </head>
</html>

Vanilla Framework can now be used in the same way it would be with a nodejs project. For information on this syntax, see the Vanilla Framework website.

Metadata

Release files for django-vanillaframework 1.0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for django-vanillaframework 1.0.2
File Size Uploaded Provenance Actions
django-vanillaframework-1.0.2.tar.gz 12.1 kB Without provenance Details for django-vanillaframework-1.0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for django-vanillaframework 1.0.2
File Interpreter ABI Platform Actions
django_vanillaframework-1.0.2-py3-none-any.whl Python 3 none any Details for django_vanillaframework-1.0.2-py3-none-any.whl

Total release size: 22.2 kB

Release files / django-vanillaframework-1.0.2.tar.gz

Download URL django-vanillaframework-1.0.2.tar.gz
Size 12.1 kB
Tags Source
SHA-256 checksum
How to use checksums
a5e989597ddc0fdf7ddde96e3ad1262b04cb6643a3df90fd4813bdfdccf55749
BLAKE2b-256 checksum
How to use checksums
93ef71a72a5af49cfcec8f035a178a9c23dc9a0e06f2f40be7087aa034f2c575
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.7

Release files / django_vanillaframework-1.0.2-py3-none-any.whl

Download URL django_vanillaframework-1.0.2-py3-none-any.whl
Size 10.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c111c748f1b383621cf992d370e981d76e3470db54e59953fd4ca22af2fbdbbd
BLAKE2b-256 checksum
How to use checksums
d76f8472acbfc54bcc5a9adf0ccdb64449d2c48110659bc0faabf2b59013d9ad
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.10.7

Security for django-vanillaframework 1.0.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page