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.

Basic features

  • Basic HTML5 template
  • Extensive and up-to-date documentation
  • Mainstream Python and Django support
  • Outstanding test coverage
  • Continuously integrated codebase

Bootstrap 4 features

  • Full-featured Bootstrap 4 template (4.6.1)
  • Integrated Google material design icon font

Bootstrap 3 features

  • Full-featured Bootstrap 3 template (3.3.7)
  • Latest Font Awesome integration (4.7.0)
  • Built-in Bootstrap and Bootswatch themes (3.3.7)

Technical requirements

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

# Python Django
1 3.7, 3.8, 3.9 2.2, 3.0, 3.1, 3.2, 4.0
2 3.10 3.2, 4.0

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.

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

Template skeletons

Prepare your page for HTML5, Bootstrap 3 or 4 using our base templates and provide your content:

  1. Extend html5-skeleton.html, bootstrap3-skeleton.html or bootstrap4-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 %}
    

Bootstrap 3 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.

Download files

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

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page