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.8.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

flask_download_btn-0.0.8-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file flask-download-btn-0.0.8.tar.gz.

File metadata

  • Download URL: flask-download-btn-0.0.8.tar.gz
  • Upload date:
  • Size: 7.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.8

File hashes

Hashes for flask-download-btn-0.0.8.tar.gz
Algorithm Hash digest
SHA256 7bf8591e63e2dbe35f2a9cce247c710072bda856047a80dd93bbfda649313dee
MD5 e149d2394e93dc05d9f6d119d2488e3d
BLAKE2b-256 a2ed5e8730b2620a72426eff89f4e4d1f354b988b7e33b1847bd30c0e2442737

See more details on using hashes here.

File details

Details for the file flask_download_btn-0.0.8-py3-none-any.whl.

File metadata

  • Download URL: flask_download_btn-0.0.8-py3-none-any.whl
  • Upload date:
  • Size: 9.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.6.8

File hashes

Hashes for flask_download_btn-0.0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 9cafe0a4170342db49d7b709475711feb0569295c91e90c9c70c43e1e5f5649a
MD5 89036f2ae5c3516a0fa9d154d290d065
BLAKE2b-256 3e53cca777ac4c10c6274664f12cd8396afc39c16b25c3f5c324397ba961312b

See more details on using hashes here.

Supported by

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