| Name | django-bootstrap-static JSON |
| Version |
5.3.3
JSON |
| download |
| home_page | None |
| Summary | A collection of Bootstrap static files. |
| upload_time | 2024-06-19 00:27:49 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | Copyright (C) 2012-2019 Derek Stegelman and contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
django
staticfiles
bootstrap
jquery
fontawesome
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
==============================================
Django Bootstrap Static Files |latest-version|
==============================================
|bootstrap| |jquery| |fontawesome| |pipeline|
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-v5.3.3-563d7c.svg
:alt: Bootstrap 5.3.3
:target: https://getbootstrap.com/
.. |jquery| image:: https://img.shields.io/badge/jQuery-v3.7.1-0769ad.svg
:alt: jQuery 3.7.1
:target: https://jquery.com/
.. |fontawesome| image:: https://img.shields.io/badge/Font_Awesome-v6.5.2-1c9a71.svg
:alt: Font Awesome 6.5.2
:target: https://fontawesome.com/icons?m=free
.. |pipeline| image:: https://github.com/bittner/django-bootstrap-static/actions/workflows/pipeline.yml/badge.svg
:alt: Build status
:target: https://github.com/bittner/django-bootstrap-static/actions/workflows/pipeline.yml
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/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/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/5.3/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/``
Tests
-----
Tests are great! And necessary. Please, add more. More is better!
We use `Tox`_.
.. code-block:: console
pip install tox
Run all the linting and tests locally using Tox like this:
.. code-block:: console
tox
.. code-block:: console
tox list
tox -e package
tox -e py310,clean
tox -e format -- tests
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.
.. _Bootstrap website / Download: https://getbootstrap.com/
.. _jQuery website / Download: https://jquery.com/download/
.. _Dependencies: https://getbootstrap.com/docs/5.0/getting-started/javascript/
.. _Font Awesome website / Download Free: https://fontawesome.com/
.. _Tox: https://tox.wiki/
.. _semver: https://semver.org/
Raw data
{
"_id": null,
"home_page": null,
"name": "django-bootstrap-static",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": "Peter Bittner <django@bittner.it>",
"keywords": "django, staticfiles, bootstrap, jquery, fontawesome",
"author": null,
"author_email": "Peter Bittner <django@bittner.it>, Derek Stegelman <dstegelman@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/79/66/bef5edab236e419297672adc218139bd617e20e66574fed24808a561e87c/django_bootstrap_static-5.3.3.tar.gz",
"platform": null,
"description": "==============================================\nDjango Bootstrap Static Files |latest-version|\n==============================================\n\n|bootstrap| |jquery| |fontawesome| |pipeline|\n\nBootstrap and optional Font Awesome static files ready for the picking.\n\nAlso ships the latest jQuery compatible with Bootstrap, for optional inclusion.\n\n.. |latest-version| image:: https://img.shields.io/pypi/v/django-bootstrap-static.svg\n :alt: Latest version on PyPI\n :target: https://pypi.python.org/pypi/django-bootstrap-static\n.. |bootstrap| image:: https://img.shields.io/badge/Bootstrap-v5.3.3-563d7c.svg\n :alt: Bootstrap 5.3.3\n :target: https://getbootstrap.com/\n.. |jquery| image:: https://img.shields.io/badge/jQuery-v3.7.1-0769ad.svg\n :alt: jQuery 3.7.1\n :target: https://jquery.com/\n.. |fontawesome| image:: https://img.shields.io/badge/Font_Awesome-v6.5.2-1c9a71.svg\n :alt: Font Awesome 6.5.2\n :target: https://fontawesome.com/icons?m=free\n.. |pipeline| image:: https://github.com/bittner/django-bootstrap-static/actions/workflows/pipeline.yml/badge.svg\n :alt: Build status\n :target: https://github.com/bittner/django-bootstrap-static/actions/workflows/pipeline.yml\n\nInstall\n=======\n\n.. code-block:: bash\n\n pip install django-bootstrap-static\n\nConfiguration\n=============\n\nTo pickup Bootstrap static files, simply include ``'bootstrap'``, and optionally\n``'fontawesome'``, in your ``INSTALLED_APPS``:\n\n.. code-block:: python\n\n INSTALLED_APPS = [\n # ...\n 'bootstrap',\n 'fontawesome',\n ]\n\nThen you can include CSS and JavaScript as usual static resources, e.g. using\n``{% static '...' %}`` in your base template as follows:\n\n.. code-block:: django\n\n {% load static %}\n <head>\n <link rel=\"stylesheet\" href=\"{% static 'bootstrap/css/bootstrap.min.css' %}\">\n <script defer src=\"{% static 'fontawesome/js/all.min.js' %}\"></script>\n </head>\n <body>\n ...\n <script src=\"{% static 'bootstrap/js/jquery.min.js' %}\"></script>\n <script src=\"{% static 'bootstrap/js/bootstrap.bundle.min.js' %}\"></script>\n </body>\n\nNote that in the above code sample we use SVG powered Font Awesome, as\nrecommended by their docs. You can use Font Awesome the classic way by\nreplacing the ``<script ...>`` tag in the ``<head>`` section above by:\n\n.. code-block:: django\n\n <link rel=\"stylesheet\" href=\"{% static 'fontawesome/css/all.min.css' %}\">\n\nIf you don't use Bootstrap features that require ``Popper.js`` (e.g. dropdowns,\npopovers, tooltips) you can include ``bootstrap.min.js`` instead of the bundle\nto save a few kilobytes of bandwidth.\n\nMore details on integration may be available from each of the two projects:\n\n- https://getbootstrap.com/docs/5.3/getting-started/introduction/\n- https://fontawesome.com/get-started (`Upgrading from Version 4 of Font Awesome`_)\n\n.. _Upgrading from Version 4 of Font Awesome:\n https://fontawesome.com/get-started/web-fonts-with-css#upgrading\n\nContribution\n============\n\nOccasionally, I forget to update this package with new bootstrap updates.\nPlease feel free to submit a PR.\n\nSources and Procedures\n----------------------\n\nBootstrap: (all files from dist package)\n `Bootstrap website / Download`_ \u279c drop into ``bootstrap/static/bootstrap/``\njQuery: (compressed, uncompressed, map)\n `jQuery website / Download`_ \u279c rename and mix into ``bootstrap/static/bootstrap/js/``\n\n Pick the latest version denoted as a dependency in ``bower.json`` (see `Dependencies`_).\nFont Awesome: (content of the ``on-server/`` folder only)\n `Font Awesome website / Download Free`_ \u279c drop into ``fontawesome/static/fontawesome/``\n\nTests\n-----\n\nTests are great! And necessary. Please, add more. More is better!\nWe use `Tox`_.\n\n.. code-block:: console\n\n pip install tox\n\nRun all the linting and tests locally using Tox like this:\n\n.. code-block:: console\n\n tox\n\n.. code-block:: console\n\n tox list\n tox -e package\n tox -e py310,clean\n tox -e format -- tests\n\nReleases\n========\n\nTo stay aligned with the Bootstrap release schedule we will keep version\nnumbers of this app in sync with the bootstrap Major.Minor.Revision changes\n(`semver`_). The additional version number will be added at the end to denote\na new change within this package itself, e.g.\n\n``django-bootstrap-static==3.3.1.1`` == Bootstrap ``3.3.1`` with an additional\npackage change.\n\n.. _Bootstrap website / Download: https://getbootstrap.com/\n.. _jQuery website / Download: https://jquery.com/download/\n.. _Dependencies: https://getbootstrap.com/docs/5.0/getting-started/javascript/\n.. _Font Awesome website / Download Free: https://fontawesome.com/\n.. _Tox: https://tox.wiki/\n.. _semver: https://semver.org/\n",
"bugtrack_url": null,
"license": "Copyright (C) 2012-2019 Derek Stegelman and contributors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "A collection of Bootstrap static files.",
"version": "5.3.3",
"project_urls": {
"source": "https://github.com/bittner/django-bootstrap-static"
},
"split_keywords": [
"django",
" staticfiles",
" bootstrap",
" jquery",
" fontawesome"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "123a3971e2a28ae9076be3ecf99086b7ceef12111920b03fc095d749eab30714",
"md5": "d8888cec91f1975f7e9eae6c31456f44",
"sha256": "c7b97fd4b89cd7553075a206ca92fd9b392759e0b69b69629595e7037320855e"
},
"downloads": -1,
"filename": "django_bootstrap_static-5.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d8888cec91f1975f7e9eae6c31456f44",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6722641,
"upload_time": "2024-06-19T00:27:28",
"upload_time_iso_8601": "2024-06-19T00:27:28.500106Z",
"url": "https://files.pythonhosted.org/packages/12/3a/3971e2a28ae9076be3ecf99086b7ceef12111920b03fc095d749eab30714/django_bootstrap_static-5.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7966bef5edab236e419297672adc218139bd617e20e66574fed24808a561e87c",
"md5": "34268289bae2431304963688a31d0a68",
"sha256": "48477597c65fd6455ea7de96053bb66d5a13a5fe104d9a9b039383a2aae00e4c"
},
"downloads": -1,
"filename": "django_bootstrap_static-5.3.3.tar.gz",
"has_sig": false,
"md5_digest": "34268289bae2431304963688a31d0a68",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5746716,
"upload_time": "2024-06-19T00:27:49",
"upload_time_iso_8601": "2024-06-19T00:27:49.552985Z",
"url": "https://files.pythonhosted.org/packages/79/66/bef5edab236e419297672adc218139bd617e20e66574fed24808a561e87c/django_bootstrap_static-5.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-19 00:27:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bittner",
"github_project": "django-bootstrap-static",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "django-bootstrap-static"
}
