| single |
# django-bootstrap3
[CI]
[Coverage Status]
[Latest PyPI version]
Bootstrap 3 for Django.
## Goal
The goal of this project is to seamlessly blend Django and Bootstrap 3.
## Maintenance Mode
Bootstrap 3 has been superseded by Bootstrap 4, which has since been
superseded by Bootstrap 5. As a result, this package is now in
**maintenance mode** and will only receive bug fixes and security updates.
No new features or enhancements will be added. We recommend that new
projects use Bootstrap 5 and encourage existing projects to consider
migrating when feasible.
For Bootstrap 4, please refer to our dedicated package:
[django-bootstrap4].
For Bootstrap 5, please refer to our dedicated package:
[django-bootstrap5].
For icons, we recommend our dedicated package: [django-icons].
## Requirements
This package requires a combination of Python and Django that is currently
supported.
See "Supported Versions" on https://www.djangoproject.com/download/.
## Documentation
The full documentation is at https://django-bootstrap3.readthedocs.io/
## Installation
1. Install using pip:
```shell script
pip install django-bootstrap3
```
Alternatively, you can install download or clone this repo and call
``pip install -e .``.
2. Add to `INSTALLED_APPS` in your `settings.py`:
```python
INSTALLED_APPS = (
# ...
"bootstrap3",
# ...
)
3. In your templates, load the `bootstrap3` library and use the
`bootstrap_*` tags:
## Example template
```djangotemplate
{% load bootstrap3 %}
{# Display a form #}
```
Example app
-----------
An example app is provided in `example`. You can run it with `make
example`.
Bugs and suggestions
--------------------
If you have found a bug or if you have a request for additional
functionality, please use the issue tracker on GitHub.
https://github.com/zostera/django-bootstrap3/issues
License
-------
You can use this under BSD-3-Clause. See [LICENSE] file for details.
Author
|