Metadata-Version: 1.1
Name: django-bootstrap-ui
Version: 0.4.0
Summary: This aims to be a powerful Django app to ease the integration of the popular Bootstrap UI framework (http://getbootstrap.com).
Home-page: https://github.com/texperience/django-bootstrap-ui
Author: Timo Rieber
Author-email: trieber@texperience.de
License: ISC License (ISCL)
Description: Welcome to django-bootstrap-ui
        ==============================
        
        .. image:: https://img.shields.io/travis/texperience/django-bootstrap-ui.svg?branch=master
            :target: https://travis-ci.org/texperience/django-bootstrap-ui
        
        .. image:: https://img.shields.io/coveralls/texperience/django-bootstrap-ui/master.svg
            :target: https://coveralls.io/r/texperience/django-bootstrap-ui?branch=master
        
        .. image:: https://img.shields.io/pypi/v/django-bootstrap-ui.svg
            :target: https://pypi.python.org/pypi/django-bootstrap-ui
        
        .. image:: https://img.shields.io/pypi/l/django-bootstrap-ui.svg
            :target: http://en.wikipedia.org/wiki/ISC_license
        
        .. image:: https://readthedocs.org/projects/django-bootstrap-ui/badge/?version=stable
            :target: http://django-bootstrap-ui.readthedocs.org/stable/
        
        django-bootstrap-ui aims to be a powerful Django app to ease the integration of the popular `Bootstrap UI framework`_. It is written in `Python`_ and built on the `Django web framework <https://www.djangoproject.com/>`_.
        
        .. _Bootstrap UI framework: http://getbootstrap.com/
        .. _Python: https://www.python.org/
        .. _Django web framework: https://www.djangoproject.com/
        
        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)
        * Ready-to-use Bootstrap component templates
        * Intuitive template tag API for generating valid Bootstrap markup
        * Extensive and up-to-date documentation
        * Mainstream Python (2.7, 3.3, 3.4, 3.5) and Django (1.8, 1.9, 1.10) support
        * Outstanding test coverage
        * Continuously integrated codebase
        
        .. _Bootswatch: https://bootswatch.com/
        
        Technical requirements
        ----------------------
        
        Below is the list of currently supported combinations of Django and Python:
        
        +------------+------------+--------------------+
        | #          | Django     | Python             |
        +============+============+====================+
        | 1          | 1.8        | 2.7, 3.3, 3.4, 3.5 |
        +------------+------------+--------------------+
        | 2          | 1.9, 1.10  | 2.7, 3.4, 3.5      |
        +------------+------------+--------------------+
        
        Installation
        ------------
        
        #. First install the package using ``pip``:
        
            .. code:: bash
        
                pip install django-bootstrap-ui
        
        #. Add ``bootstrap_ui`` to your ``INSTALLED_APPS`` setting:
        
            .. code:: python
        
                INSTALLED_APPS = (
                    ...
                    'bootstrap_ui',
                    ...
                )
        
        Usage
        -----
        
        Bootstrap template
        ******************
        
        Prepare your page for Bootstrap and provide your content:
        
        #. Extend ``bootstrap-skeleton.html`` in your base template:
        
            .. code:: Django
        
                {% extends "bootstrap_ui/bootstrap-skeleton.html" %}
        
        #. Fill predefined blocks with your content:
        
            .. code:: Django
        
                {% 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:
        
        .. code:: python
        
            # django-bootstrap-ui settings
            DJANGO_BOOTSTRAP_UI_THEME = 'bootswatch-paper'
        
        Bootstrap component templates
        *****************************
        
        Render complete Bootstrap components by including our default implementations. Example:
        
        #. Provide a list of strings ``['alpha', 'beta', 'gamma']`` as template variable ``items``
        
        #. Include ``listgroup.html`` parameterized with ``type='list'`` and ``items=items``:
        
            .. code:: Django
        
                {% include 'bootstrap_ui/listgroup.html' with type='list' items=items only %}
        
        Template tag API
        ****************
        
        Generate your own, customized Bootstrap elements using our template tags. Example:
        
        #. Load ``bootstrap_ui_tags`` in your template:
        
            .. code:: Django
        
                {% load bootstrap_ui_tags %}
        
        #. Use Bootstrap components through intuitive template tags:
        
            .. code:: Django
        
                {% listgroup %}
                    {% listgroupitem %}
                        Your raw text.
                    {% endlistgroupitem %}
                    {% listgroupitem %}
                        You may also use a {{ context_variable }}.
                    {% endlistgroupitem %}
                {% endlistgroup %}
        
        #. Some Bootstrap components support different html tags, to change the default add a parameter:
        
            .. code:: Django
        
                {% listgroup use_tag="div" %}
                    ...
                    Your list group content goes here.
                    ...
                {% endlistgroup %}
        
        Continue reading in our `detailed documentation <https://django-bootstrap-ui.readthedocs.org>`_ at readthedocs.org.
        
        Code and contribution
        ---------------------
        
        The code is open source and released under the `ISC License (ISCL)`_. It is available on `GitHub`_ 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.
        
        .. _ISC License (ISCL): http://en.wikipedia.org/wiki/ISC_license
        .. _Semantic Versioning: http://semver.org/
        .. _GitHub: https://github.com/texperience/django-bootstrap-ui
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Framework :: Django :: 1.10
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
