Skip to content

Commit e5a6286

Browse files
committed
Update README.md
1 parent faeb0a5 commit e5a6286

File tree

1 file changed

+37
-11
lines changed

1 file changed

+37
-11
lines changed
Lines changed: 37 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,51 @@
11
## Hello there!
2-
### Welcome to the repository folder for the Vizzu tutorial @ PyCon MEA
2+
### Welcome to the repository folder for the Vizzu talk @ The Austin Python Meetup
33
## We're thrilled to have you here with us! :blush:
44

5-
In this readme and the repo, you'll find a collection of useful resources related to the talk and the workshop, such as the ipyvizzu notebooks used throughout the sessions, along with some additional ones that I've prepared for you to experiment and learn more about our tool.
5+
In this readme and the repo, you'll find a collection of useful resources related to the workshop.
66

7-
Moreover, you'll find some helpful links to the Streamlit app and its source code, the ipyvizzu documentation, as well as to the bidirectional component that integrates ipyvizzu into Streamlit.
7+
Moreover, you'll find some helpful links to the Streamlit apps and their source code, the ipyvizzu documentation, and the bidirectional component that integrates ipyvizzu into Streamlit.
88

99
### Useful links
1010
- The tutorial app for using ipyvizzu in Streamlit: https://intro-to-vizzu-in.streamlit.app/
11-
- Streamlit-Vizzu bidirectional component code, how-to and source code of the tutorial app: https://github.com/vizzu-streamlit/streamlit-vizzu
12-
<br/><br/>
13-
- Installation guides of Anaconda & Streamlit: https://www.anaconda.com/download, https://docs.streamlit.io/library/get-started/installation
11+
- Vizzu builder app: https://vizzu-builder.streamlit.app/
12+
13+
### Steps to start individual work
14+
- Check out and get through the installation guide below
15+
- Fork the repo of the tutorial app (locally if you will) - https://github.com/vizzu-streamlit/streamlit-vizzu-intro/
16+
- Get some data! Check out the sample datasets in the tutorial repo (or within the data folder here; they are identical) and pick one you want to start working with. You can also use your own CSV or samples from the Vega datasets: https://github.com/altair-viz/vega_datasets
17+
- Create a new py file and reuse snippets from the tutorial examples - remember, most of them are in the pages folder
18+
- Use the builder app to generate ipyvizzu code: https://vizzu-builder.streamlit.app/ and reuse it within your app
19+
- Be creative! :)
20+
- Share your app using the Streamlit Community Cloud
21+
22+
### Installation guide
23+
**For Those With Experience in Python and Local Development:**
24+
25+
If you're accustomed to working with Python packages locally and prefer having everything set up on your machine, this pathway is for you.
26+
27+
- **Environment Setup**: Install Streamlit, streamlit-vizzu, and ipyvizzu-story (along with their dependencies) in a virtual environment. Both pip and conda are great options for this step.
28+
29+
`pip install streamlit streamlit-vizzu ipyvizzu-story`
30+
- **Download Sample Materials**: Grab the sample apps and datasets using [this link](https://github.com/vizzu-streamlit/streamlit-vizzu-intro/archive/refs/heads/main.zip). Download and extract the zip file to a convenient location on your computer.
31+
- **Get Ready to Share**: Planning to showcase your work publicly? Create a free account at [Streamlit Community Cloud](https://streamlit.io/cloud) to share your apps with the world. Keep in mind that Streamlit requests access to all your public repositories. If this raises any concerns for you, a straightforward solution is to create a new GitHub account.
32+
33+
**For Those New to Python Packages and Local Setup:**
34+
35+
If you're newer to the world of Python or prefer a setup that doesn't require local installations, we've got you covered.
36+
37+
- **GitHub Account**: Ensure you have a GitHub account ready to go. If not, you can create one [here](https://github.com/join).
38+
- **Streamlit Community Cloud**: Set up your free account at [Streamlit Community Cloud](https://streamlit.io/cloud) to run and share apps directly from your browser.
39+
- **Get Coding in the Cloud**: Once registered, you can write code and work with sample apps directly in your browser through Codespace, with no local setup required. For more info on this last step, read this blogpost: https://blog.streamlit.io/edit-inbrowser-with-github-codespaces/
40+
41+
### Other links
42+
- Streamlit intro presentation: https://docs.google.com/presentation/d/1asGx8vMvvHjqLENL0G1J84wDOojBUp5jBo5CaE_CQlo/edit#slide=id.g29371e65c4e_0_0
43+
- Streamlit-Vizzu bidirectional component code: https://github.com/vizzu-streamlit/streamlit-vizzu
1444
- Streamlit Community Cloud sign-up and documentation: https://streamlit.io/cloud & https://docs.streamlit.io/streamlit-community-cloud
1545
<br/><br/>
1646
- ipyvizzu documentation, examples & tutorial: http://ipyvizzu.com/
1747
- ipyvizzu repo: https://github.com/vizzuhq/ipyvizzu - :star2:'s are very much appreciated.
1848
<br/><br/>
19-
- ipyvizzu-story documentation, examples & tutorial https://ipyvizzu-story.vizzuhq.com
20-
- ipyvizzu-story repo: https://github.com/vizzuhq/ipyvizzu-story
21-
- Blog post about using ipyvizzu-story in Streamlit: https://blog.streamlit.io/create-an-animated-data-story-with-ipyvizzu-and-streamlit/
22-
<br/><br/>
2349

2450
### Come join the community!
2551
We'd like to invite you to join our community on Slack. We're always eager to welcome new members and help them get started, answer any questions you may have, and provide feedback and support for your projects and contributions. Here's the invite link: https://join.slack.com/t/vizzu-community/shared_invite/zt-w2nqhq44-2CCWL4o7qn2Ns1EFSf9kEg
@@ -31,4 +57,4 @@ We love to see our community members actively engaged with us! There are a few w
3157

3258
Thank you for your time, and we look forward to hearing from you soon!
3359

34-
*Peter & the Vizzu Team*
60+
*Peter & the Vizzu Team*

0 commit comments

Comments
 (0)