Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Restructure page content of example app to showcase upcoming features.
- Loading branch information
Showing
3 changed files
with
119 additions
and
20 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| import streamlit as st | ||
| from src.streamlit_uploads_library.gallery import Gallery | ||
|
|
||
| # Configure page title, layout, menu items and links. | ||
| st.set_page_config( | ||
| page_title="Streamlit Uploads Library", | ||
| layout="wide", | ||
| menu_items={ | ||
| "Get Help": "https://github.com/hreikin/streamlit-uploads-library", | ||
| "Report a bug": "https://github.com/hreikin/streamlit-uploads-library/issues", | ||
| "About": """ | ||
| Streamlit Uploads Library is created and maintained by [@hreikin](https://hreikin.co.uk). The source code is available on [GitHub](https://github.com/hreikin/streamlit-uploads-library), community contributions are always welcome. | ||
| MIT licensed: [MIT](https://opensource.org/license/mit/) | ||
| """ | ||
| }, | ||
| ) | ||
|
|
||
| source_code = """ | ||
| import streamlit as st | ||
| from pathlib import Path | ||
| @st.cache_resource(show_spinner="Refreshing gallery...") | ||
| class Gallery(): | ||
| def __init__(self, directory, expanded=True, file_extensions=(".png", ".jpg", ".jpeg"), gallery_type="container", label="**Gallery**" or None, number_of_columns=5, show_filename=False): | ||
| self.directory = Path(directory).resolve() | ||
| self.expanded = expanded | ||
| self.file_extensions = file_extensions | ||
| self.gallery_type = gallery_type | ||
| self.label = label | ||
| self.number_of_columns = number_of_columns | ||
| self.show_filename = show_filename | ||
| self.gallery = self.create_gallery() | ||
| def fetch_files(self): | ||
| self.all_files = list() | ||
| self.all_filenames = list() | ||
| for item in self.directory.rglob("*"): | ||
| if item.is_file() and item.name.endswith(self.file_extensions): | ||
| self.all_files.append(str(item.resolve())) | ||
| self.all_filenames.append(str(item.name)) | ||
| return self.all_files, self.all_filenames | ||
| def create_gallery(self): | ||
| if self.gallery_type == "expander": | ||
| if self.label == None: | ||
| self.label = "" | ||
| self.container_or_expander = st.expander(label=self.label, expanded=self.expanded) | ||
| else: | ||
| self.container_or_expander = st.expander(label=self.label, expanded=self.expanded) | ||
| else: | ||
| self.container_or_expander = st.container() | ||
| with self.container_or_expander: | ||
| if self.label == None: | ||
| pass | ||
| else: | ||
| self.gallery_label = st.markdown(f"**{self.label}**") | ||
| with self.container_or_expander: | ||
| self.col_idx = 0 | ||
| self.filename_idx = 0 | ||
| self.max_idx = self.number_of_columns-1 | ||
| self.gallery_files, self.gallery_filenames = self.fetch_files() | ||
| self.all_columns = list(st.columns(self.number_of_columns)) | ||
| for img in self.gallery_files: | ||
| with self.all_columns[self.col_idx]: | ||
| if self.show_filename == True: | ||
| st.image(img, caption=self.gallery_filenames[self.filename_idx], use_column_width=True) | ||
| else: | ||
| st.image(img, use_column_width=True) | ||
| if self.col_idx < self.max_idx: | ||
| self.col_idx += 1 | ||
| else: | ||
| self.col_idx = 0 | ||
| self.filename_idx += 1 | ||
| return self.container_or_expander | ||
| """ | ||
| example_usage = """ | ||
| A simple gallery for use in Streamlit projects. Using the gallery is simple, 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. | ||
| """ | ||
| configuration = """ | ||
| - `directory` (required): A `str()` of the path to the folder containing the gallery images, for example, `"assets"`. | ||
| - `expanded` (optional): A `bool()`, passing `False` starts the expander type gallery closed, default is open and `True`. | ||
| - `file_extensions` (optional): A `tuple()` containing strings of the file extensions to include in the gallery, default is `(".png", ".jpg", ".jpeg")`. | ||
| - `gallery_type` (optional): A `str()` with either "container" or "expander" used as the keyword, the default is `"container"`. | ||
| - `label` (optional): A `str()` containing the name of the gallery, passing `None` disables the label. The default value is `"Gallery"`. | ||
| - `number_of_columns` (optional): An `int()` defining the number of required columns, default is `5`. | ||
| - `show_filenames` (optional): A `bool()`, passing `True` displays the filenames, the default is `False` which hides them. | ||
| """ | ||
| example_usage_code = """ | ||
| import streamlit as st | ||
| from streamlit_uploads_library import Gallery | ||
| st.set_page_config(page_title="Streamlit Uploads Library", layout="wide") | ||
| default_gallery = Gallery(directory="assets") | ||
| gallery_with_columns = Gallery(directory="assets", label="**Gallery - Columns**", number_of_columns=3) | ||
| expander_gallery = Gallery(directory="assets", expanded=True, gallery_type="expander", label="**Gallery - Expander**") | ||
| multiple_options_gallery = Gallery(directory="assets", gallery_type="expander", label="**Gallery - Multiple Options**", number_of_columns=3, show_filename=False) | ||
| """ | ||
|
|
||
| with st.sidebar: | ||
| st.info("Welcome to the `streamlit-uploads-library` example app.") | ||
|
|
||
| st.header("Streamlit Uploads Library - Gallery") | ||
| st.markdown(body=example_usage) | ||
| st.markdown(body=configuration) | ||
| st.code(body=example_usage_code) | ||
| default_gallery = Gallery(directory="assets") | ||
| gallery_with_columns = Gallery(directory="assets", label="**Gallery - Columns**", number_of_columns=3) | ||
| expander_gallery = Gallery(directory="assets", expanded=True, gallery_type="expander", label="**Gallery - Expander**") | ||
| multiple_options_gallery = Gallery(directory="assets", gallery_type="expander", label="**Gallery - Multiple Options**", number_of_columns=3, show_filename=False) | ||
|
|
||
| with st.expander(label="**Source Code**", expanded=True): | ||
| st.code(body=source_code) |