Skip to main content

Bootstrap 4 & 5 helper for your Flask projects.

Project description

Bootstrap-Flask

PyPI - License Current version on PyPI Build status Coverage Status Open Collective

Bootstrap-Flask is a collection of Jinja macros for Bootstrap 4 & 5 and Flask. It helps you to render Flask-related data and objects to Bootstrap markup HTML more easily:

  • Render Flask-WTF/WTForms form object to Bootstrap Form.
  • Render data objects (dict or class objects) to Bootstrap Table.
  • Render Flask-SQLAlchemy Pagination object to Bootstrap Pagination.
  • etc.

Installation

$ pip install -U bootstrap-flask

Example

Register the extension:

from flask import Flask
# To follow the naming rule of Flask extension, although
# this project's name is Bootstrap-Flask, the actual package
# installed is named `flask_bootstrap`.
from flask_bootstrap import Bootstrap5

app = Flask(__name__)
bootstrap = Bootstrap5(app)

Assuming you have a Flask-WTF form like this:

class LoginForm(FlaskForm):
    username = StringField('Username', validators=[DataRequired(), Length(1, 20)])
    password = PasswordField('Password', validators=[DataRequired(), Length(8, 150)])
    remember = BooleanField('Remember me')
    submit = SubmitField()

Now with the render_form macro:

{% from 'bootstrap5/form.html' import render_form %}
<html>
<head>
<!-- Bootstrap CSS -->
</head>
<body>

<h2>Login</h2>
{{ render_form(form) }}

<!-- Bootstrap JS -->
</body>
</html>

You will get a form like this with only one line code (i.e. {{ render_form(form) }}):

form rendering

When the validation fails, the error messages will be rendered with proper style:

error form rendering

Read the Basic Usage docs for more details.

Live demo

https://bootstrap-flask-example.azurewebsites.net/

Donate

If you find Bootstrap-Flask useful, please consider donating today. Your donation keeps Bootstrap-Flask maintained and updated with Bootstrap.

Links

Notes for Bootstrap 4 & 5 support

The Bootstrap 5 support is added in Bootstrap-Flask 2.0 version. Now you can use the separate extension class for different Bootstrap major versions.

For Bootstrap 4, use the Bootstrap4 class:

from flask_bootstrap import Bootstrap4

# ...
bootstrap = Bootstrap4(app)

and import macros from the template path bootstrap4/:

{% from 'bootstrap4/form.html' import render_form %}

For Bootstrap 5, use the Bootstrap5 class:

from flask_bootstrap import Bootstrap5

# ...
bootstrap = Bootstrap5(app)

and import macros from the template path bootstrap5/:

{% from 'bootstrap5/form.html' import render_form %}

The Bootstrap class and bootstrap/ template path are deprecated since 2.0 and will be removed in 3.0.

Migration from Flask-Bootstrap

If you come from Flask-Bootstrap, check out this tutorial on how to migrate to this extension.

Contributing

For guidance on setting up a development environment and how to make a contribution to Bootstrap-Flask, see the development documentation and Flask's contributing guidelines.

License

This project is licensed under the MIT License (see the LICENSE file for details). Some macros were part of Flask-Bootstrap and were modified under the terms of its BSD License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bootstrap_flask-2.5.0.tar.gz (4.5 MB view details)

Uploaded Source

Built Distribution

bootstrap_flask-2.5.0-py3-none-any.whl (4.6 MB view details)

Uploaded Python 3

File details

Details for the file bootstrap_flask-2.5.0.tar.gz.

File metadata

  • Download URL: bootstrap_flask-2.5.0.tar.gz
  • Upload date:
  • Size: 4.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for bootstrap_flask-2.5.0.tar.gz
Algorithm Hash digest
SHA256 b6e5ea1ce40616fb289c9e85d4beedd43fea2048b4032f4abc83a582db494978
MD5 f7693d939711e23e957cc291270f6d9d
BLAKE2b-256 edb524cb630ee5bc1ba8e5a5fbac3b59331af77d000df837cdb77ab69b3c4a5b

See more details on using hashes here.

Provenance

The following attestation bundles were made for bootstrap_flask-2.5.0.tar.gz:

Publisher: release.yml on helloflask/bootstrap-flask

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bootstrap_flask-2.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for bootstrap_flask-2.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dd76203fe4d46062bf1e7fd2a25aaccdc54affde9acc282f6aa4da4f4bbf2a5a
MD5 822a4a29029f4452d5c1f3e71e70a303
BLAKE2b-256 a6bda61a69ba3595735049f5acdcaa049a6c731be4b083dad4ae4b3a85b21e90

See more details on using hashes here.

Provenance

The following attestation bundles were made for bootstrap_flask-2.5.0-py3-none-any.whl:

Publisher: release.yml on helloflask/bootstrap-flask

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page