Metadata-Version: 2.0
Name: django-bootstrap-static
Version: 4.1.1
Summary: A collection of Bootstrap static files.
Home-page: http://github.com/bittner/django-bootstrap-static
Author: Peter Bittner
Author-email: django@bittner.it
License: MIT
Keywords: django,staticfiles,bootstrap,jquery,fontawesome
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Framework :: Django
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content :: CGI Tools/Libraries
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: MIT License

==============================================
Django Bootstrap Static Files |latest-version|
==============================================

|bootstrap| |jquery| |fontawesome|

Bootstrap and optional Font Awesome static files ready for the picking.

Also ships the latest jQuery compatible with Bootstrap, for optional inclusion.

.. |latest-version| image:: https://img.shields.io/pypi/v/django-bootstrap-static.svg
   :alt: Latest version on PyPI
   :target: https://pypi.python.org/pypi/django-bootstrap-static
.. |bootstrap| image:: https://img.shields.io/badge/Bootstrap-v4.1.1-563d7c.svg
   :alt: Bootstrap 4.1.1
   :target: https://getbootstrap.com/
.. |jquery| image:: https://img.shields.io/badge/jQuery-v3.3.1-0769ad.svg
   :alt: jQuery 3.3.1
   :target: https://jquery.com/
.. |fontawesome| image:: https://img.shields.io/badge/Font_Awesome-v5.0.10-1c9a71.svg
   :alt: Font Awesome 5.0.10
   :target: https://fontawesome.com/icons?m=free

Install
=======

.. code-block:: bash

    pip install django-bootstrap-static

Configuration
=============

To pickup Bootstrap static files, simply include ``'bootstrap'``, and optionally
``'fontawesome'``, in your ``INSTALLED_APPS``:

.. code-block:: python

    INSTALLED_APPS = [
        # ...
        'bootstrap',
        'fontawesome',
    ]

Then you can include CSS and JavaScript as usual static resources, e.g. using
``{% static '...' %}`` in your base template as follows:

.. code-block:: django

    {% load static %}
    <head>
        <link rel="stylesheet" href="{% static 'bootstrap/css/bootstrap.min.css' %}">
        <script defer src="{% static 'fontawesome/js/fontawesome-all.min.js' %}"></script>
    </head>
    <body>
        ...
        <script src="{% static 'bootstrap/js/jquery.min.js' %}"></script>
        <script src="{% static 'bootstrap/js/bootstrap.bundle.min.js' %}"></script>
    </body>

Note that in the above code sample we use SVG powered Font Awesome, as
recommended by their docs.  You can use Font Awesome the classic way by
replacing the ``<script ...>`` tag in the ``<head>`` section above by:

.. code-block:: django

    <link rel="stylesheet" href="{% static 'fontawesome/css/fontawesome-all.min.css' %}">

If you don't use Bootstrap features that require ``Popper.js`` (e.g. dropdowns,
popovers, tooltips) you can include ``bootstrap.min.js`` instead of the bundle
to save a few kilobytes of bandwidth.

More details on integration may be available from each of the two projects:

- https://getbootstrap.com/docs/4.0/getting-started/introduction/
- https://fontawesome.com/get-started (`Upgrading from Version 4 of Font Awesome`_)

.. _Upgrading from Version 4 of Font Awesome:
    https://fontawesome.com/get-started/web-fonts-with-css#upgrading

Contribution
============

Occasionally, I forget to update this package with new bootstrap updates.
Please feel free to submit a PR.

Sources and Procedures
----------------------

Bootstrap: (all files from dist package)
    `Bootstrap website / Download`_ -> drop into ``bootstrap/static/bootstrap/``
jQuery: (compressed, uncompressed, map)
    `jQuery website / Download`_ -> rename and mix into ``bootstrap/static/bootstrap/js/``

    Pick the latest version denoted as a dependency in ``bower.json`` (see `Dependencies`_).
Font Awesome: (content of the ``on-server/`` folder only)
    `Font Awesome website / Download Free`_ -> drop into ``fontawesome/static/fontawesome/``

.. _Bootstrap website / Download: https://getbootstrap.com/
.. _jQuery website / Download: https://jquery.com/download/
.. _Dependencies: https://getbootstrap.com/docs/4.0/getting-started/javascript/
.. _Font Awesome website / Download Free: https://fontawesome.com/

Releases
========

To stay aligned with the Bootstrap release schedule we will keep version
numbers of this app in sync with the bootstrap Major.Minor.Revision changes
(`semver`_).  The additional version number will be added at the end to denote
a new change within this package itself, e.g.

``django-bootstrap-static==3.3.1.1`` == Bootstrap ``3.3.1`` with an additional
package change.

.. _semver: https://semver.org/


