Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ [IDEA] - Streamlit Query Strings #144

Open
Asaurus1 opened this issue Jun 5, 2023 · 6 comments
Open

✨ [IDEA] - Streamlit Query Strings #144

Asaurus1 opened this issue Jun 5, 2023 · 6 comments

Comments

@Asaurus1
Copy link
Contributor

Asaurus1 commented Jun 5, 2023

Description

Hi!

I am working on a small Streamlit add-on over at https://github.com/Asaurus1/streamlit-qs to make integrating data from the URL query string easier. At its core, this relies on the experimental experiemental_get_query_string and experimental_set_query_string API's. I'm wondering whether streamlit-extras would be open to including this library once it is a little more polished, or if your preference would be to wait for the streamlit APIs to get out of their experimental stage first.

Example: https://query-string.streamlit.app/

Cheers,
A

@arnaudmiribel
Copy link
Owner

Hey @Asaurus1! That is a great library, thanks a lot for sharing it here. Make sure to share it also in Streamlit's forum at discuss.streamlit.io - makes me think of one blog post our data team posted some time ago. Definitely keen on adding it here to streamlit-extras, let me know if you want to do it and throw a PR.

Best,

@Asaurus1
Copy link
Contributor Author

Asaurus1 commented Jun 5, 2023

@arnaudmiribel I'd be happy to throw it on a PR once I've made a few more tweaks. It absolutely does look like what's on that blog-post, just packaged a bit more cleanly to control direct interactions with the query string.

You'll have to forgive me, I am very familiar with git but only within a corporate context and not so much with OSS and GitHub. Should I create a branch in this project for the PR, or fork the entire project and create a PR from that?

@arnaudmiribel
Copy link
Owner

It absolutely does look like what's on that blog-post, just packaged a bit more cleanly to control direct interactions with the query string.

Exactly! That's what I like about it 💯

Should I create a branch in this project for the PR, or fork the entire project and create a PR from that?

Best is to fork and create a PR from that!

@Asaurus1
Copy link
Contributor Author

Asaurus1 commented Jun 5, 2023

Great! And it seems like I would want to add the project like the annotated_text one, where there's a thin wrapper around the imported functions and some examples, correct?

If so, I will need to publish this to pypi first (which I was going to do anyways), so I will get back to you here in a bit when that's ready. Thanks for the quick responses and help!

@arnaudmiribel
Copy link
Owner

You can follow our contribution guidelines here to get things properly set up, hope that helps!

I would want to add the project like the annotated_text one

Exactly, the annotated_text is a good example to follow where the source code lives somewhere else (in your repo, and published in a standalone PyPI package) instead of pasting the code within streamlit-extras. Great thing about your package is that there's only streamlit as a dependency, so that's great!

This was referenced Jun 5, 2023
@Asaurus1
Copy link
Contributor Author

Asaurus1 commented Jun 7, 2023

Alright the PR is ready

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants