Skip to main content

Vanilla Framework frontend for Django

Project description

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.

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-vanillaframework-1.0.2.tar.gz (12.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

django_vanillaframework-1.0.2-py3-none-any.whl (10.1 kB view details)

Uploaded Python 3

File details

Details for the file django-vanillaframework-1.0.2.tar.gz.

File metadata

  • Download URL: django-vanillaframework-1.0.2.tar.gz
  • Upload date:
  • Size: 12.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.7

File hashes

Hashes for django-vanillaframework-1.0.2.tar.gz
Algorithm Hash digest
SHA256 a5e989597ddc0fdf7ddde96e3ad1262b04cb6643a3df90fd4813bdfdccf55749
MD5 5c79d9c7f94f82dd9820f16a2a98e305
BLAKE2b-256 93ef71a72a5af49cfcec8f035a178a9c23dc9a0e06f2f40be7087aa034f2c575

See more details on using hashes here.

File details

Details for the file django_vanillaframework-1.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for django_vanillaframework-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c111c748f1b383621cf992d370e981d76e3470db54e59953fd4ca22af2fbdbbd
MD5 1f9a533a6b254135453bd8a87434341d
BLAKE2b-256 d76f8472acbfc54bcc5a9adf0ccdb64449d2c48110659bc0faabf2b59013d9ad

See more details on using hashes here.

Supported by

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