Skip to content

Commit

Permalink
Change project name due to a conflict with an old/abandoned project o…
Browse files Browse the repository at this point in the history
…n pypi.
  • Loading branch information
hreikin committed Mar 7, 2023
1 parent 198a09f commit da8a07a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions README.md
@@ -1,4 +1,4 @@
# Streamlit Gallery
# Streamlit Simple Gallery

A simple gallery for use in Streamlit projects.

Expand All @@ -7,12 +7,12 @@ A simple gallery for use in Streamlit projects.
Installation is via pip:

```
pip install streamlit-gallery
pip install streamlit-simple-gallery
```

## Usage

Using the gallery is simple, import `streamlit-gallery` and then instantiate the class with the
Using the gallery is simple, import `streamlit_simple_gallery` and then instantiate the class with the
required `directory` variable. Other options can be configured by passing in different variables
when instantiating the class.

Expand All @@ -27,7 +27,7 @@ gallery = ImageGallery(directory="assets")
To run the example application provided in the repository:

```bash
git clone https://github.com/hreikin/streamlit-gallery
git clone https://github.com/hreikin/streamlit-simple-gallery
cd streamlit-gallery/example/
python -m venv .venv
source .venv/bin/activate
Expand Down
10 changes: 5 additions & 5 deletions example/pages/Cached.py
Expand Up @@ -6,10 +6,10 @@
page_title="Streamlit Simple Gallery",
layout="wide",
menu_items={
"Get Help": "https://github.com/hreikin/streamlit-gallery",
"Report a bug": "https://github.com/hreikin/streamlit-gallery/issues",
"Get Help": "https://github.com/hreikin/streamlit-simple-gallery",
"Report a bug": "https://github.com/hreikin/streamlit-simple-gallery/issues",
"About": """
Streamlit Gallery is created and maintained by [@hreikin](https://hreikin.co.uk). The source code is available on [GitHub](https://github.com/hreikin/streamlit-gallery), community contributions are always welcome.
Streamlit Gallery is created and maintained by [@hreikin](https://hreikin.co.uk). The source code is available on [GitHub](https://github.com/hreikin/streamlit-simple-gallery), community contributions are always welcome.
MIT licensed: [MIT](https://opensource.org/license/mit/)
"""
Expand Down Expand Up @@ -59,7 +59,7 @@ def create_gallery(self):
return self.source_image_dropdown
"""
example_usage = """
Using the gallery is simple, import `streamlit-gallery` and then instantiate the class with the
Using the gallery is simple, import `streamlit_simple_gallery` and then instantiate the class with the
required `directory` variable. Other options can be configured by passing in different variables
when instantiating the class.
"""
Expand All @@ -74,7 +74,7 @@ def create_gallery(self):
with st.sidebar:
st.info("Welcome to the `streamlit-simple-gallery` example app.")

st.header("Streamlit Simple Gallery")
st.header("Caching")
st.markdown(example_usage)
st.code(body=example_usage_code, language="python")
gallery = ImageGallery(directory="assets", expanded=True, label="**Example Image Gallery**")
Expand Down

0 comments on commit da8a07a

Please sign in to comment.