Skip to main content

django-bootstrap-ui simplifies the integration of the popular Bootstrap UI framework (http://getbootstrap.com).

Project description

https://gitlab.com/texperience/django-bootstrap-ui/badges/master/pipeline.svg https://gitlab.com/texperience/django-bootstrap-ui/badges/master/coverage.svg https://img.shields.io/pypi/v/django-bootstrap-ui.svg https://img.shields.io/pypi/l/django-bootstrap-ui.svg https://readthedocs.org/projects/django-bootstrap-ui/badge/?version=stable

django-bootstrap-ui simplifies the integration of the popular Bootstrap UI framework. It is written in Python and built on the Django web framework.

Features

  • Basic HTML5 template (3.3.7)

  • Full-featured Bootstrap 3 template (3.3.7)

  • Latest Font Awesome integration (4.7.0)

  • Built-in Bootstrap and Bootswatch themes (3.3.7)

  • Extensive and up-to-date documentation

  • Mainstream Python (3.6, 3.7, 3.8) and Django (2.2) support

  • Outstanding test coverage

  • Continuously integrated codebase

Technical requirements

Below is the list of currently supported combinations of Django and Python:

#

Django

Python

1

2.2

3.6, 3.7, 3.8

Installation

  1. First install the package using pip:

    pip install django-bootstrap-ui
  2. Add bootstrap_ui to your INSTALLED_APPS setting:

    INSTALLED_APPS = (
        ...
        'bootstrap_ui',
        ...
    )

Usage

Bootstrap 3 template

Prepare your page for Bootstrap 3 and provide your content:

  1. Extend bootstrap3-skeleton.html in your base template:

    {% extends "bootstrap_ui/bootstrap3-skeleton.html" %}
  2. Fill predefined blocks with your content:

    {% block body-content %}
        <h1>Hello, I'm using django-bootstrap-ui!</h1>
    {% endblock %}

Themes

You can style your page with Bootstrap or Bootswatch themes. Set DJANGO_BOOTSTRAP_UI_THEME to a valid identifier in your settings.py for a project-wide default theme:

# django-bootstrap-ui settings
DJANGO_BOOTSTRAP_UI_THEME = 'bootswatch-paper'

Continue reading in our detailed documentation at readthedocs.org.

Code and contribution

The code is open source and released under the ISC License (ISCL). It is available on Gitlab and follows the guidelines about Semantic Versioning for transparency within the release cycle and backward compatibility whenever possible.

All contributions are welcome, whether bug reports, code contributions and reviews, documentation or feature requests.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

django_bootstrap_ui-1.0.5-py3-none-any.whl (6.8 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