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:
- Automatic enabling and disabling: A download button is automatically disabled on click and re-enabling on download completion.
- Web form handling: Applications can modify a download button on click based on web form responses.
- 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for flask-download-btn-0.0.10.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 86f5a746646b468fb41e8693ba1018e51a726514135700f0565178d9af026556 |
|
MD5 | 717e73f8e9c09f073364f0aec2db2569 |
|
BLAKE2b-256 | 5f549c37d789e10440bc3bc41debef0bca043d1d979363b0679a30a6a4cb527d |
Hashes for flask_download_btn-0.0.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 798ebcc6d189e595aeeedcbe9dbadb216f32fbc3050011c942c601417c8dcc2f |
|
MD5 | a4432aca7b5b1f6bae5b43b2bb299655 |
|
BLAKE2b-256 | dbdac284cee440180da742dc596fd7dafecdc18f245a59a22687fa57e2f1b846 |