Skip to main content

Flask-Download-Btn defines a SQLALchemy Mixin for creating Bootstrap download buttons in a Flask application.

Project description

Flask-Download-Btn

Flask-Download-Btn defines a SQLALchemy Mixin for creating Bootstrap download buttons in a Flask application.

Its key features are:

  1. Automatic enabling and disabling: A download button is automatically disabled on click and re-enabling on download completion.
  2. Web form handling: Applications can modify a download button on click based on web form responses.
  3. Progress bar: Download buttons report progress using a progress bar updated with server-sent events.

Example: Basic use

Suppose we want to include a download button which downloads hello_world.txt accessible at HELLO_WORLD_URL. On click, we want to disable the button and re-enable it when the file finishes downloading.

After setup, we can achieve this with the following:

@app.route('/')
def index():
    btn = DownloadBtn()
    btn.text = 'Download'
    btn.downloads = [(HELLO_WORLD_URL, 'hello_world')]
    db.session.add(btn)
    db.session.commit()
    return render_template('index.html', download_btn=btn)

Documentation

You can find the latest documentation at https://dsbowen.github.io/flask-download-btn.

License

Publications which use this software should include the following citation for SQLAlchemy-Function and its dependencies, SQLAlchemy-Function and SQLAlchemy-Mutable:

Bowen, D.S. (2019). Flask-Download-Btn[Computer software]. https://dsbowen.github.io/flask-download-btn.

Bowen, D.S. (2019). SQLAlchemy-Function [Computer software]. https://dsbowen.github.io/sqlalchemy-function.

Bowen, D.S. (2019). SQLAlchemy-Mutable [Computer software]. https://dsbowen.github.io/sqlalchemy-mutable.

This project is licensed under the MIT License 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

flask-download-btn-0.0.12.tar.gz (7.4 kB view hashes)

Uploaded Source

Built Distribution

flask_download_btn-0.0.12-py3-none-any.whl (9.8 kB view hashes)

Uploaded Python 3

Supported by

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