======================
django CMS Bootstrap 4
======================
|pypi| |build| |coverage|
**django CMS Bootstrap 4** is a plugin bundle for django CMS providing several
components from the popular `Bootstrap 4 <http://getbootstrap.com/>`_ library.
.. note::
This project is endorsed by the `django CMS Association <https://www.django-cms.org/en/about-us/>`_.
That means that it is officially accepted by the dCA as being in line with our roadmap vision and development/plugin policy.
Join us on `Slack <https://www.django-cms.org/slack/>`_.
.. image:: preview.gif
*******************************************
Contribute to this project and win rewards
*******************************************
Because this is a an open-source project, we welcome everyone to
`get involved in the project <https://www.django-cms.org/en/contribute/>`_ and
`receive a reward <https://www.django-cms.org/en/bounty-program/>`_ for their contribution.
Become part of a fantastic community and help us make django CMS the best CMS in the world.
We'll be delighted to receive your
feedback in the form of issues and pull requests. Before submitting your
pull request, please review our `contribution guidelines
<http://docs.django-cms.org/en/latest/contributing/index.html>`_.
The project makes use of git pre-commit hooks to maintain code quality. Please follow the
installation steps to get `pre-commit <https://pre-commit.com/#installation>`_ setup in your development environment.
We're grateful to all contributors who have helped create and maintain this package.
Contributors are listed at the `contributors <https://github.com/django-cms/djangocms-bootstrap4/graphs/contributors>`_
section.
Documentation
=============
See ``REQUIREMENTS`` in the `setup.py <https://github.com/divio/djangocms-bootstrap4/blob/master/setup.py>`_
file for additional dependencies:
|python| |django| |djangocms|
* Django Filer 1.7 or higher
* Django Text CKEditor 3.1 or higher
Make sure `django Filer <http://django-filer.readthedocs.io/en/latest/installation.html>`_
and `django CMS Text CKEditor <https://github.com/divio/djangocms-text-ckeditor>`_
are installed and configured appropriately.
Installation
------------
For a manual install:
* run ``pip install djangocms-bootstrap4``
* add the following entries to your ``INSTALLED_APPS``::
'djangocms_icon',
'djangocms_link',
'djangocms_picture',
'djangocms_bootstrap4',
'djangocms_bootstrap4.contrib.bootstrap4_alerts',
'djangocms_bootstrap4.contrib.bootstrap4_badge',
'djangocms_bootstrap4.contrib.bootstrap4_card',
'djangocms_bootstrap4.contrib.bootstrap4_carousel',
'djangocms_bootstrap4.contrib.bootstrap4_collapse',
'djangocms_bootstrap4.contrib.bootstrap4_content',
'djangocms_bootstrap4.contrib.bootstrap4_grid',
'djangocms_bootstrap4.contrib.bootstrap4_jumbotron',
'djangocms_bootstrap4.contrib.bootstrap4_link',
'djangocms_bootstrap4.contrib.bootstrap4_listgroup',
'djangocms_bootstrap4.contrib.bootstrap4_media',
'djangocms_bootstrap4.contrib.bootstrap4_picture',
'djangocms_bootstrap4.contrib.bootstrap4_tabs',
'djangocms_bootstrap4.contrib.bootstrap4_utilities',
* run ``python manage.py migrate``
The Code plugin uses the ace code editor which is loaded from a CDN by default.
If you want the ace code editor to be served from static files, please use
``djangocms-bootstrap4[static-ace]`` instead of ``djangocms-bootstrap4`` in your
requirements or with pip. Make the static files fore the ace code editor available
to your project by adding ``djangocms_static_ace`` to your project's
``INSTALLED_APPS``.
Configuration
-------------
django CMS Bootstrap 4 **utilises** the following django CMS plugins:
* **django CMS Link**: `Link <https://github.com/divio/djangocms-link/>`_
* **django CMS Picture**: `Picture <https://github.com/divio/djangocms-picture/>`_
* **django CMS Icon**: `Icon <https://github.com/divio/djangocms-icon>`_
It provides the following **standard** Bootstrap 4 components:
* `Alerts <https://getbootstrap.com/docs/4.0/components/alerts/>`_
* `Badge <https://getbootstrap.com/docs/4.0/components/badge/>`_
* `Card <https://getbootstrap.com/docs/4.0/components/card/>`_
* `Carousel <https://getbootstrap.com/docs/4.0/components/carousel/>`_
* `Collapse <https://getbootstrap.com/docs/4.0/components/collapse/>`_
* `Content (Blockquote, Code, Figure) <https://getbootstrap.com/docs/4.0/content/>`_
* `Grid (Container, Row, Column) <https://getbootstrap.com/docs/4.0/layout/grid/>`_
* `Jumbotron <https://getbootstrap.com/docs/4.0/components/jumbotron/>`_
* `Link / Button <https://getbootstrap.com/docs/4.0/components/buttons/>`_
* `List group <https://getbootstrap.com/docs/4.0/components/list-group/>`_
* `Media <https://getbootstrap.com/docs/4.0/layout/media-object/>`_
* `Picture / Image <https://getbootstrap.com/docs/4.0/content/images/>`_
* `Tabs <https://getbootstrap.com/docs/4.0/components/navs/#tabs>`_
* `Utilities (Spacing) <https://getbootstrap.com/docs/4.0/utilities/>`_
django CMS Bootstrap 4 **does not** add the styles or javascript files to your
frontend, these need to be added at your discretion.
Settings
~~~~~~~~
There are various settings possible on django CMS Bootstrap 4, to restrict them
for now only the following can be changed::
DJANGOCMS_BOOTSTRAP4_TAG_CHOICES = ['div', 'section', 'article', 'header', 'footer', 'aside']
DJANGOCMS_BOOTSTRAP4_CAROUSEL_TEMPLATES = (
('default', _('Default')),
)
DJANGOCMS_BOOTSTRAP4_GRID_SIZE = 12
DJANGOCMS_BOOTSTRAP4_GRID_CONTAINERS = (
(_('Default'), (
('container', _('Container')),
('container-fluid', _('Fluid container')),
)),
(_('Custom'), (
('container-yours', _('Your container')),
)),
)
DJANGOCMS_BOOTSTRAP4_GRID_COLUMN_CHOICES = (
('col', _('Column')),
('w-100', _('Break')),
('', _('Empty'))
)
DJANGOCMS_BOOTSTRAP4_USE_ICONS = True
DJANGOCMS_BOOTSTRAP4_TAB_TEMPLATES = (
('default', _('Default')),
)
DJANGOCMS_BOOTSTRAP4_SPACER_SIZES = (
('0', '* 0'),
('1', '* .25'),
('2', '* .5'),
('3', '* 1'),
('4', '* 1.5'),
('5', '* 3'),
)
DJANGOCMS_BOOTSTRAP4_CAROUSEL_ASPECT_RATIOS = (
(16, 9),
)
DJANGOCMS_BOOTSTRAP4_COLOR_STYLE_CHOICES = (
('primary', _('Primary')),
('secondary', _('Secondary')),
('success', _('Success')),
('danger', _('Danger')),
('warning', _('Warning')),
('info', _('Info')),
('light', _('Light')),
('dark', _('Dark')),
('custom', _('Custom')),
)
Please be aware that this package does not support djangocms-text-ckeditor's
`Drag & Drop Images <https://github.com/divio/djangocms-text-ckeditor/#drag--drop-images>`_
so be sure to set ``TEXT_SAVE_IMAGE_FUNCTION = None``.
Running Tests
-------------
You can run tests by executing::
virtualenv env
source env/bin/activate
pip install -r tests/requirements/djNN_cmsNN.txt # where NN is an available appropriate version
python setup.py test
To run the frontend make sure to use **node 10.x**.
.. |pypi| image:: https://badge.fury.io/py/djangocms-bootstrap4.svg
:target: http://badge.fury.io/py/djangocms-bootstrap4
.. |build| image:: https://travis-ci.org/divio/djangocms-bootstrap4.svg?branch=master
:target: https://travis-ci.org/divio/djangocms-bootstrap4
.. |coverage| image:: https://codecov.io/gh/divio/djangocms-bootstrap4/branch/master/graph/badge.svg
:target: https://codecov.io/gh/divio/djangocms-bootstrap4
.. |python| image:: https://img.shields.io/badge/python-3.5+-blue.svg
:target: https://pypi.org/project/djangocms-bootstrap4/
.. |django| image:: https://img.shields.io/badge/django-2.2,%203.0,%203.1-blue.svg
:target: https://www.djangoproject.com/
.. |djangocms| image:: https://img.shields.io/badge/django%20CMS-3.7%2B-blue.svg
:target: https://www.django-cms.org/
Raw data
{
"_id": null,
"home_page": "https://github.com/django-cms/djangocms-bootstrap4",
"name": "djangocms-bootstrap4",
"maintainer": "Django CMS Association and contributors",
"docs_url": null,
"requires_python": null,
"maintainer_email": "info@django-cms.org",
"keywords": null,
"author": "Divio AG",
"author_email": "info@divio.ch",
"download_url": "https://files.pythonhosted.org/packages/44/a3/41e8bfec527b290c9695ce7c391c2a6547acf700764f3d6d33886f924285/djangocms_bootstrap4-3.0.2.tar.gz",
"platform": null,
"description": "======================\ndjango CMS Bootstrap 4\n======================\n\n|pypi| |build| |coverage|\n\n**django CMS Bootstrap 4** is a plugin bundle for django CMS providing several\ncomponents from the popular `Bootstrap 4 <http://getbootstrap.com/>`_ library.\n\n.. note::\n\n This project is endorsed by the `django CMS Association <https://www.django-cms.org/en/about-us/>`_.\n That means that it is officially accepted by the dCA as being in line with our roadmap vision and development/plugin policy.\n Join us on `Slack <https://www.django-cms.org/slack/>`_.\n\n.. image:: preview.gif\n\n\n*******************************************\nContribute to this project and win rewards\n*******************************************\n\nBecause this is a an open-source project, we welcome everyone to\n`get involved in the project <https://www.django-cms.org/en/contribute/>`_ and\n`receive a reward <https://www.django-cms.org/en/bounty-program/>`_ for their contribution.\nBecome part of a fantastic community and help us make django CMS the best CMS in the world.\n\nWe'll be delighted to receive your\nfeedback in the form of issues and pull requests. Before submitting your\npull request, please review our `contribution guidelines\n<http://docs.django-cms.org/en/latest/contributing/index.html>`_.\n\nThe project makes use of git pre-commit hooks to maintain code quality. Please follow the\ninstallation steps to get `pre-commit <https://pre-commit.com/#installation>`_ setup in your development environment.\n\nWe're grateful to all contributors who have helped create and maintain this package.\nContributors are listed at the `contributors <https://github.com/django-cms/djangocms-bootstrap4/graphs/contributors>`_\nsection.\n\n\nDocumentation\n=============\n\nSee ``REQUIREMENTS`` in the `setup.py <https://github.com/divio/djangocms-bootstrap4/blob/master/setup.py>`_\nfile for additional dependencies:\n\n|python| |django| |djangocms|\n\n* Django Filer 1.7 or higher\n* Django Text CKEditor 3.1 or higher\n\nMake sure `django Filer <http://django-filer.readthedocs.io/en/latest/installation.html>`_\nand `django CMS Text CKEditor <https://github.com/divio/djangocms-text-ckeditor>`_\nare installed and configured appropriately.\n\n\nInstallation\n------------\n\nFor a manual install:\n\n* run ``pip install djangocms-bootstrap4``\n* add the following entries to your ``INSTALLED_APPS``::\n\n 'djangocms_icon',\n 'djangocms_link',\n 'djangocms_picture',\n 'djangocms_bootstrap4',\n 'djangocms_bootstrap4.contrib.bootstrap4_alerts',\n 'djangocms_bootstrap4.contrib.bootstrap4_badge',\n 'djangocms_bootstrap4.contrib.bootstrap4_card',\n 'djangocms_bootstrap4.contrib.bootstrap4_carousel',\n 'djangocms_bootstrap4.contrib.bootstrap4_collapse',\n 'djangocms_bootstrap4.contrib.bootstrap4_content',\n 'djangocms_bootstrap4.contrib.bootstrap4_grid',\n 'djangocms_bootstrap4.contrib.bootstrap4_jumbotron',\n 'djangocms_bootstrap4.contrib.bootstrap4_link',\n 'djangocms_bootstrap4.contrib.bootstrap4_listgroup',\n 'djangocms_bootstrap4.contrib.bootstrap4_media',\n 'djangocms_bootstrap4.contrib.bootstrap4_picture',\n 'djangocms_bootstrap4.contrib.bootstrap4_tabs',\n 'djangocms_bootstrap4.contrib.bootstrap4_utilities',\n\n* run ``python manage.py migrate``\n\nThe Code plugin uses the ace code editor which is loaded from a CDN by default.\nIf you want the ace code editor to be served from static files, please use\n``djangocms-bootstrap4[static-ace]`` instead of ``djangocms-bootstrap4`` in your\nrequirements or with pip. Make the static files fore the ace code editor available\nto your project by adding ``djangocms_static_ace`` to your project's\n``INSTALLED_APPS``.\n\n\nConfiguration\n-------------\n\ndjango CMS Bootstrap 4 **utilises** the following django CMS plugins:\n\n* **django CMS Link**: `Link <https://github.com/divio/djangocms-link/>`_\n* **django CMS Picture**: `Picture <https://github.com/divio/djangocms-picture/>`_\n* **django CMS Icon**: `Icon <https://github.com/divio/djangocms-icon>`_\n\nIt provides the following **standard** Bootstrap 4 components:\n\n* `Alerts <https://getbootstrap.com/docs/4.0/components/alerts/>`_\n* `Badge <https://getbootstrap.com/docs/4.0/components/badge/>`_\n* `Card <https://getbootstrap.com/docs/4.0/components/card/>`_\n* `Carousel <https://getbootstrap.com/docs/4.0/components/carousel/>`_\n* `Collapse <https://getbootstrap.com/docs/4.0/components/collapse/>`_\n* `Content (Blockquote, Code, Figure) <https://getbootstrap.com/docs/4.0/content/>`_\n* `Grid (Container, Row, Column) <https://getbootstrap.com/docs/4.0/layout/grid/>`_\n* `Jumbotron <https://getbootstrap.com/docs/4.0/components/jumbotron/>`_\n* `Link / Button <https://getbootstrap.com/docs/4.0/components/buttons/>`_\n* `List group <https://getbootstrap.com/docs/4.0/components/list-group/>`_\n* `Media <https://getbootstrap.com/docs/4.0/layout/media-object/>`_\n* `Picture / Image <https://getbootstrap.com/docs/4.0/content/images/>`_\n* `Tabs <https://getbootstrap.com/docs/4.0/components/navs/#tabs>`_\n* `Utilities (Spacing) <https://getbootstrap.com/docs/4.0/utilities/>`_\n\ndjango CMS Bootstrap 4 **does not** add the styles or javascript files to your\nfrontend, these need to be added at your discretion.\n\n\nSettings\n~~~~~~~~\n\nThere are various settings possible on django CMS Bootstrap 4, to restrict them\nfor now only the following can be changed::\n\n DJANGOCMS_BOOTSTRAP4_TAG_CHOICES = ['div', 'section', 'article', 'header', 'footer', 'aside']\n\n DJANGOCMS_BOOTSTRAP4_CAROUSEL_TEMPLATES = (\n ('default', _('Default')),\n )\n\n DJANGOCMS_BOOTSTRAP4_GRID_SIZE = 12\n DJANGOCMS_BOOTSTRAP4_GRID_CONTAINERS = (\n (_('Default'), (\n ('container', _('Container')),\n ('container-fluid', _('Fluid container')),\n )),\n (_('Custom'), (\n ('container-yours', _('Your container')),\n )),\n )\n DJANGOCMS_BOOTSTRAP4_GRID_COLUMN_CHOICES = (\n ('col', _('Column')),\n ('w-100', _('Break')),\n ('', _('Empty'))\n )\n\n DJANGOCMS_BOOTSTRAP4_USE_ICONS = True\n\n DJANGOCMS_BOOTSTRAP4_TAB_TEMPLATES = (\n ('default', _('Default')),\n )\n\n DJANGOCMS_BOOTSTRAP4_SPACER_SIZES = (\n ('0', '* 0'),\n ('1', '* .25'),\n ('2', '* .5'),\n ('3', '* 1'),\n ('4', '* 1.5'),\n ('5', '* 3'),\n )\n\n DJANGOCMS_BOOTSTRAP4_CAROUSEL_ASPECT_RATIOS = (\n (16, 9),\n )\n\n DJANGOCMS_BOOTSTRAP4_COLOR_STYLE_CHOICES = (\n ('primary', _('Primary')),\n ('secondary', _('Secondary')),\n ('success', _('Success')),\n ('danger', _('Danger')),\n ('warning', _('Warning')),\n ('info', _('Info')),\n ('light', _('Light')),\n ('dark', _('Dark')),\n ('custom', _('Custom')),\n )\n\nPlease be aware that this package does not support djangocms-text-ckeditor's\n`Drag & Drop Images <https://github.com/divio/djangocms-text-ckeditor/#drag--drop-images>`_\nso be sure to set ``TEXT_SAVE_IMAGE_FUNCTION = None``.\n\n\nRunning Tests\n-------------\n\nYou can run tests by executing::\n\n virtualenv env\n source env/bin/activate\n pip install -r tests/requirements/djNN_cmsNN.txt # where NN is an available appropriate version\n python setup.py test\n\nTo run the frontend make sure to use **node 10.x**.\n\n\n.. |pypi| image:: https://badge.fury.io/py/djangocms-bootstrap4.svg\n :target: http://badge.fury.io/py/djangocms-bootstrap4\n.. |build| image:: https://travis-ci.org/divio/djangocms-bootstrap4.svg?branch=master\n :target: https://travis-ci.org/divio/djangocms-bootstrap4\n.. |coverage| image:: https://codecov.io/gh/divio/djangocms-bootstrap4/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/divio/djangocms-bootstrap4\n\n.. |python| image:: https://img.shields.io/badge/python-3.5+-blue.svg\n :target: https://pypi.org/project/djangocms-bootstrap4/\n.. |django| image:: https://img.shields.io/badge/django-2.2,%203.0,%203.1-blue.svg\n :target: https://www.djangoproject.com/\n.. |djangocms| image:: https://img.shields.io/badge/django%20CMS-3.7%2B-blue.svg\n :target: https://www.django-cms.org/\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Adds Bootstrap 4 components as plugins.",
"version": "3.0.2",
"project_urls": {
"Homepage": "https://github.com/django-cms/djangocms-bootstrap4"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b91e9583fdcb2611152498411aeedc3e53abdb90b05edbf10c7302c343c5f879",
"md5": "eb572d3beb0be903cf6251c8a3f28e2b",
"sha256": "3b7e7eb1b7551cf433bf2bb0f3601d47645203c3bb4ad75ec097eb4bd81a34cf"
},
"downloads": -1,
"filename": "djangocms_bootstrap4-3.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eb572d3beb0be903cf6251c8a3f28e2b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 181854,
"upload_time": "2024-08-09T21:52:33",
"upload_time_iso_8601": "2024-08-09T21:52:33.523733Z",
"url": "https://files.pythonhosted.org/packages/b9/1e/9583fdcb2611152498411aeedc3e53abdb90b05edbf10c7302c343c5f879/djangocms_bootstrap4-3.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "44a341e8bfec527b290c9695ce7c391c2a6547acf700764f3d6d33886f924285",
"md5": "9a4b1e8d18feee48d694790938176c80",
"sha256": "e931aefadbd22ab00e6cea8b7224da767afea125df15bf0c8a8d5f7872153e64"
},
"downloads": -1,
"filename": "djangocms_bootstrap4-3.0.2.tar.gz",
"has_sig": false,
"md5_digest": "9a4b1e8d18feee48d694790938176c80",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 117936,
"upload_time": "2024-08-09T21:52:35",
"upload_time_iso_8601": "2024-08-09T21:52:35.285677Z",
"url": "https://files.pythonhosted.org/packages/44/a3/41e8bfec527b290c9695ce7c391c2a6547acf700764f3d6d33886f924285/djangocms_bootstrap4-3.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-09 21:52:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "django-cms",
"github_project": "djangocms-bootstrap4",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "djangocms-bootstrap4"
}
JSON
