Skip to main content

Package for rapid development of web-based user interfaces.

Project description

Python Bootwrap

Python + Bootstrap = Bootwrap

Continuous Integration Status Code Coverage Percentage Codacy Badge Project License Project Documentation

Bootwrap is a Python library for rapid developing of web-based user interfaces (WebUI). It helps creating WebUI using Python code only and can be used in conjunction with different web-development frameworks such as Flask. Under the hood, this library wraps one of the most popular front-end toolkit Bootstrap.

As a showcase of what this library is capable of please check the documentation. The entire documentation web interface is created using the Bootwrap.

Installing

Install and update using pip:

~$ pip install bootwrap

Bootwrap package has no external dependencies!

Why & where you might use Bootwrap?

The vast majority of web applications consist of frontend and backend. If you are a small team or even a solo developer you need to divide resources and time to focus on both parts. This often results in switching between different platforms such as Python and React, AngularJs, Flask templates (HTML, CSS, JS), etc. But what if your main focus is the backend and you also don't want to compromise on the quality of your WebUI. In this case, the Bootwrap library is for you! It will help you develop WebUI without leaving the Python ecosystem and not waste your time on HTML, CSS, and Javascript. To understand its capability just clone the project and run the demo application ":pig: PiggyBank".

Screenshots Collage

For more information also read the Bootwrap documentation.

Hello World Application

The following code will create three pages application with a top-level menu bar for navigations. Since this application is based on Flask make sure that you installed it as well.

from flask import Flask
from markupsafe import Markup
from bootwrap import Page, Menu, Image, Anchor, Button, Text

app = Flask(__name__, static_folder='docs', static_url_path='')

LOGO = 'https://github.com/mmgalushka/bootwrap/blob/main/docs/logo.png?raw=true'
FAVICON = 'https://raw.githubusercontent.com/mmgalushka/bootwrap/main/docs/favicon.ico'

class MyMenu(Menu):
    def __init__(self):
        super().__init__(
            logo=Image(LOGO, width=32, alt='Logo'),
            brand=Text('Bootwrap').as_strong().as_light().ms(2),
            anchors=[
                Anchor('Home').link('/'),
                Anchor('About').link('/about')
            ], 
            actions=[
                Button('Sign In').as_outline().as_light().link('/signin')
            ]
        )

class MyPage(Page):
    def __init__(self, container):
        super().__init__(
            favicon = FAVICON,
            title='Hello World Application',
            menu=MyMenu(),
            container=container
        )

@app.route('/')
def home():
    return Markup(MyPage(container=Text('Home').as_heading(1)))

@app.route('/about')
def about():
    return Markup(MyPage(container=Text('About').as_heading(1)))

@app.route('/signin')
def signin():
    return Markup(MyPage(container=Text('Sign In').as_heading(1)))

if __name__ == '__main__':
    app.run(debug=True)

Use the following command to launch the application.

$ flask run
  * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)

The result should look like.

Simple Example

Contributing

For information on how to set up a development environment and how to make a contribution to Bootwrap, see the contributing guidelines.

Links

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

bootwrap-1.2.4.tar.gz (1.8 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bootwrap-1.2.4-py3-none-any.whl (52.7 kB view details)

Uploaded Python 3

File details

Details for the file bootwrap-1.2.4.tar.gz.

File metadata

  • Download URL: bootwrap-1.2.4.tar.gz
  • Upload date:
  • Size: 1.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for bootwrap-1.2.4.tar.gz
Algorithm Hash digest
SHA256 9fb81aba0b823d2183e6d60c1537f02ce1d9d5240752558e526bc8e62b36d77d
MD5 cc2386c8364b55cabb0dbe517afd3931
BLAKE2b-256 69b53e92511868b368320d79fa5a446e54140fd0780ea7f1a97675f199a31b9b

See more details on using hashes here.

File details

Details for the file bootwrap-1.2.4-py3-none-any.whl.

File metadata

  • Download URL: bootwrap-1.2.4-py3-none-any.whl
  • Upload date:
  • Size: 52.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for bootwrap-1.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 8de78691f2894e29d885b0c9c6ee55380617bab63c4333b3b341fb76d5202dda
MD5 eef7872071002f23c5881300d40c047b
BLAKE2b-256 88f1dde2aa4aca6c84cf9b05ad4d06dcb930ce1227fb55e1ea23c004aa16187d

See more details on using hashes here.

Supported by

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