https://github.com/fohrloop/dash-uploader
The alternative upload component for python Dash applications.
https://github.com/fohrloop/dash-uploader
dash plotly-dash python python-3 python-dash upload-file
Last synced: about 1 month ago
JSON representation
The alternative upload component for python Dash applications.
- Host: GitHub
- URL: https://github.com/fohrloop/dash-uploader
- Owner: fohrloop
- License: mit
- Archived: true
- Created: 2020-04-26T22:28:09.000Z (over 5 years ago)
- Default Branch: dev
- Last Pushed: 2025-07-19T18:43:41.000Z (5 months ago)
- Last Synced: 2025-10-11T13:57:42.819Z (3 months ago)
- Topics: dash, plotly-dash, python, python-3, python-dash, upload-file
- Language: Python
- Homepage:
- Size: 2.22 MB
- Stars: 152
- Watchers: 3
- Forks: 35
- Open Issues: 41
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-dash - dash-uploader - Upload component for Dash. Supports large data files. (Component Libraries)
README
## 🚨 dash-uploader is archived 2025-07-19. See: [#153](https://github.com/fohrloop/dash-uploader/issues/153)
--------
   
# 📤 dash-uploader
The alternative upload component for [Dash](https://dash.plotly.com/) applications.
## 📢 dash-uploader 0.7.0 pre-release available
🎉 There is pre-release version of dash-uploader 0.7.0 available in PyPI! 🎉
```
python -m pip install dash-uploader --pre
```
- It fixes the multi-file upload issues!
- Please, test it and give feedback to this [discussion](https://github.com/fohrloop/dash-uploader/discussions/88).
## Table of contents
- [Short summary](#short-summary)
- [dash-uploader vs. dcc.Upload](#dash-uploader-vs-dccupload)
- [Installing](#installing)
- [Quickstart](#quickstart)
- [Simple example](#simple-example)
- [Example with callback](#example-with-callback-and-other-options)
- [Contributing](#contributing)
- [Documentation](#documentation)
- [Changelog](#changelog)
- [Credits](#credits)
## Short summary
💾 Data file size has no limits. (Except the hard disk size)
☎ Call easily a callback after uploading is finished.
📤 Upload files using [flow.js](https://github.com/flowjs/flow.js/)
📦 All JS and CSS bundled with the package. No need for network calls for CSS/JS.
✅ Works with Dash 1.1.0.+ & Python 3.6+. (Possibly with other versions, too)
### dash-uploader vs. [dcc.Upload](https://dash.plotly.com/dash-core-components/upload)
| | dash-uploader | [dcc.Upload](https://dash.plotly.com/dash-core-components/upload) |
| --------------------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Underlying technology | [flow.js](https://github.com/flowjs/flow.js/) | HTML5 API |
| File size | Unlimited | max ~150-200MB ([link](https://community.plotly.com/t/dash-upload-component-decoding-large-files/8033/11)) |
| Uploads to | Hard disk (server side) | First to browser memory (user side) Then, to server using callbacks. |
| Data type | Uploaded as file; no need to parse at server side. | Uploaded as byte64 encoded string -> Needs parsing |
| See upload progress? | Progressbar out of the box | No upload indicators out of the box. Generic loading indicator possible. [Progressbar not possible](https://community.plotly.com/t/upload-after-confirmation-and-progress-bar/7172). |
# Installing
```
pip install dash-uploader
```
# Quickstart
Full documentation [here](docs/dash-uploader.md)
>⚠️**Security note**: The Upload component allows POST requests and uploads of arbitrary files to the server harddisk and one should take this into account (with user token checking etc.) if used as part of a public website! For this you can utilize the `http_request_handler` argument of the [du.configure_upload](https://github.com/fohrloop/dash-uploader/blob/master/docs/dash-uploader.md#duconfigure_upload). (New in version 0.5.0)
## Simple example
```python
import dash
import dash_html_components as html
import dash_uploader as du
app = dash.Dash(__name__)
# 1) configure the upload folder
du.configure_upload(app, r"C:\tmp\Uploads")
# 2) Use the Upload component
app.layout = html.Div([
du.Upload(),
])
if __name__ == '__main__':
app.run_server(debug=True)
```
## Example with callback (and other options)
- **New in version 0.7.0:** Functions decorated with [`@du.callback`](https://github.com/fohrloop/dash-uploader/blob/dev/docs/dash-uploader.md#ducallback) must take `status` ([`du.UploadStatus`](https://github.com/fohrloop/dash-uploader/blob/dev/docs/dash-uploader.md#duuploadstatus)) object as the only input parameter (previously, `filenames`)
```python
from pathlib import Path
import uuid
import dash_uploader as du
import dash
import dash_html_components as html
from dash.dependencies import Input, Output, State
app = dash.Dash(__name__)
UPLOAD_FOLDER_ROOT = r"C:\tmp\Uploads"
du.configure_upload(app, UPLOAD_FOLDER_ROOT)
def get_upload_component(id):
return du.Upload(
id=id,
max_file_size=1800, # 1800 MB
filetypes=['csv', 'zip'],
upload_id=uuid.uuid1(), # Unique session id
)
def get_app_layout():
return html.Div(
[
html.H1('Demo'),
html.Div(
[
get_upload_component(id='dash-uploader'),
html.Div(id='callback-output'),
],
style={ # wrapper div style
'textAlign': 'center',
'width': '600px',
'padding': '10px',
'display': 'inline-block'
}),
],
style={
'textAlign': 'center',
},
)
# get_app_layout is a function
# This way we can use unique session id's as upload_id's
app.layout = get_app_layout
@du.callback(
output=Output("callback-output", "children"),
id="dash-uploader",
)
def callback_on_completion(status: du.UploadStatus):
return html.Ul([html.Li(str(x)) for x in status.uploaded_files])
if __name__ == '__main__':
app.run_server(debug=True)
```
## Contributing
| What? | How? |
| :----------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 🐞 Found a bug? | 🎟 File an Issue |
| 🙋♂️ Need help? | ❔ Ask a question on StackOverflow
📧 Use this thread on community.plotly.com |
| 💡 Want to submit a feature request? | 🎭 Discuss about it on community.plotly.com
🎫 File an Issue (feature request) |
| 🧙 Want to write code? | 🔥 Here's how you get started! |
## Documentation
- [Documentation](docs/dash-uploader.md)
- [Developer documentation](docs/CONTRIBUTING.md)
- [Migration Guide](https://github.com/fohrloop/dash-uploader/wiki/Migration-Guide)
## Changelog
- [Changelog](./docs/CHANGELOG.md)
## Credits
- History: This package is based on the React 16 compatible version [dash-resumable-upload](https://github.com/westonkjones/dash-resumable-upload) (0.0.4) by [Weston Jones](https://github.com/westonkjones/) which in turn is based on [dash-resumable-upload](https://github.com/rmarren1/dash-resumable-upload) (0.0.3) by [Ryan Marren](https://github.com/rmarren1)
- The package boilerplate is taken from the [dash-component-boilerplate](https://github.com/plotly/dash-component-boilerplate).
- The uploading JS function utilizes the [flow.js](https://github.com/flowjs/flow.js/) (2.14.x).
- The JS component is created using [React](https://github.com/facebook/react) (17.0.x)
- The CSS styling is mostly from [Bootstrap](https://getbootstrap.com/) 4.