Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hreikin/streamlit-uploads-library

A simple uploads library and gallery for use in Streamlit projects.
https://github.com/hreikin/streamlit-uploads-library

streamlit streamlit-application streamlit-gallery streamlit-library streamlit-uploads

Last synced: 2 days ago
JSON representation

A simple uploads library and gallery for use in Streamlit projects.

Awesome Lists containing this project

README 

        
# Streamlit Uploads Library



[![Open in Streamlit](https://static.streamlit.io/badges/streamlit_badge_black_white.svg)](https://hreikin-streamlit-uploads-library-home-ar6h9h.streamlit.app/)



Streamlit Uploads Library is a simple, widget-based uploads library and gallery for use in 

Streamlit projects. Check out the demo using the Streamlit Cloud button above.



This package provides a simple wrapper around `st.file_uploader` with a save function included and 

also provides library and gallery views for use in Streamlit projects. Using any of the views is 

easy, import `streamlit_uploads_library` and then instantiate the class with the required 

`directory` variable. Other options can be configured by passing in different variables when 

instantiating the class. More information can be found in the Github repository.



## Installation



Installation is available via pip:



```

pip install streamlit-uploads-library

```



## Usage



Using any of the provided views is easy, import `streamlit_uploads_library` and then instantiate the class 

with the required `directory` variable. Other options can be configured by passing in different variables 

when instantiating the class.



### Library View



- `directory` (required): A str() of the path to the folder containing the library images, for example, "assets".

- `file_extensions` (optional): A tuple() containing strings of the file extensions to include in the library, default is (".png", ".jpg", ".jpeg").

- `image_alignment` (optional): A str() with the CSS keyword used to align the images and details columns.

- `number_of_columns` (optional): An int() defining the number of required columns, default is 5.

- `show_details` (optional): A bool() to show or hide the file and edit details, False hides them, default is True to show them.

- `uid` (optional): A str() containing a unique identifier allowing you to create multiple libraries on the same page containing the same images.



```python

import streamlit as st

from streamlit_uploads_library.library import Library



st.set_page_config(page_title="Streamlit Uploads Library", layout="wide")

library = Library(directory="assets/landscape/")

library_columns = Library(directory="assets/portrait/", number_of_columns=4, uid="library-columns")

library_mixed = Library(directory="assets/mixed/", uid="mixed-library")

```



### Gallery View



- `directory` (required): A str() of the path to the folder containing the gallery images, for example, "assets".

- `file_extensions` (optional): A tuple() containing strings of the file extensions to include in the gallery, default is (".png", ".jpg", ".jpeg").

- `image_alignment` (optional): A str() with the CSS keyword used to align the images and details columns.

- `number_of_columns` (optional): An int() defining the number of required columns, default is 5.

- `show_details` (optional): A bool() to show or hide the file and edit details, True shows them, default is False to hide them and create a gallery.

- `uid` (optional): A str() containing a unique identifier allowing you to create multiple galleries on the same page containing the same images.



```python

import streamlit as st

from streamlit_uploads_library.gallery import Gallery



st.set_page_config(page_title="Streamlit Uploads Library", layout="wide")

default_gallery = Gallery(directory="assets/landscape/")

columns_gallery = Gallery(directory="assets/portrait/", number_of_columns=4, uid="gallery-columns")

mixed_gallery = Gallery(directory="assets/mixed/", uid="mixed-gallery")

```



### Upload View



The file uploader comes with multiple options able to be configured including 2 different view 

types. It is not required to use this and you can easily replace it with your own, it is provided 

as a convenience so you don't need to create the code yourself or replicate it across multiple 

projects.



- `save_location` (required): A str() of the path to the folder you wish to save images to, for example, "assets".

- `expander` (optional): A bool() used to set the initial state of the expander, only used when using the "expander" widget_type.

- `file_extensions` (optional): A list() containing strings of the file extensions to include in the library, default is (".png", ".jpg", ".jpeg").

- `info_msg` (optional): A str() used to set an info message above the uploader, default is "Upload new files here.".

- `header` (optional): A str() used to set the header of the "expander" or the header in the "container" type widget, default is "Upload Files", can be set to None to not display it.

- `uid` (optional): A str() containing a unique identifier allowing you to create multiple file uploaders on the same page.

- `upload_label` (optional): A str() used to set the label of the file uploader widget, default is "Upload Files", can be set to None to display an empty string instead.

- `widget_type` (optional): A str() defining the type of widget to use to display the file uploader, options are "container" or "expander", default is "container".



```python

import streamlit as st

from streamlit_uploads_library.uploads import UploadFiles



st.set_page_config(page_title="Streamlit Uploads Library", layout="wide")

default_uploader = UploadFiles(save_location="assets")

expander_uploader = UploadFiles(save_location="assets", widget_type="expander")

```



## Custom File Details



A default set of basic file details is provided for each image within the library. Using class 

inheritance this can be overridden to create your own file details section if you wish to include 

more information or different options.



```python

import streamlit as st

from streamlit_uploads_library.library import Library



class CustomLibrary(Library):

    def __init__(self, directory, file_extensions=(".png", ".jpg", ".jpeg"), image_alignment="end", number_of_columns=5, show_details=True, uid="custom"):

        self.directory = directory

        self.file_extensions = file_extensions

        self.image_alignment = image_alignment

        self.number_of_columns = number_of_columns

        self.show_details = show_details

        self.uid = uid

        super(CustomLibrary, self).__init__(self.directory, self.file_extensions, self.image_alignment, self.number_of_columns, self.show_details, self.uid)



    def create_details(_self, img, filename_idx, uid):

        # Your details section code here

```



## Caching



Streamlit Uploads Library makes use of the `st.cache_resource` decorator so the library and gallery 

will load from the cache instead of reloading the images each time the app is run. You will 

probably want to clear your cache after uploading new files to your app, the file uploader view 

provided by this package takes care of that for you but if you use your own file uploader and save 

function then to clear the cache you can use the `st.cache_resource.clear()` function provided by 

Streamlit.



## Example App (Demo)



To run the example application provided in the repository:



```bash

git clone https://github.com/hreikin/streamlit-uploads-library

cd streamlit-uploads-library/

python -m venv .venv

source .venv/bin/activate

pip install -r requirements.txt

streamlit run Home.py

```