Skip to content

Commit

Permalink
Merge pull request #653 from akshayka/aka/docs-marimo
Browse files Browse the repository at this point in the history
docs: add marimo usage to README
  • Loading branch information
ObservedObserver authored Nov 8, 2024
2 parents 0bd47fd + 56fe646 commit 9aebec0
Showing 1 changed file with 32 additions and 4 deletions.
36 changes: 32 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,13 @@

Visit [Google Colab](https://colab.research.google.com/drive/171QUQeq-uTLgSj1u-P9DQig7Md1kpXQ2?usp=sharing), [Kaggle Code](https://www.kaggle.com/code/lxy21495892/airbnb-eda-pygwalker-demo) or [Graphic Walker Online Demo](https://graphic-walker.kanaries.net/) to test it out!

> If you prefer using R, check [GWalkR](https://github.com/Kanaries/GWalkR), the R wrapper of Graphic Walker.
In addition to Jupyter, PyGWalker also works in [marimo notebooks](https://github.com/marimo-team/marimo) and [streamlit](https://github.com/streamlit/streamlit).

> If you prefer using R, check [GWalkR](https://github.com/Kanaries/GWalkR), the R wrapper of Graphic Walker.
https://github.com/Kanaries/pygwalker/assets/22167673/2b940e11-cf8b-4cde-b7f6-190fb10ee44b



# Getting Started
> Check our video tutorial about using pygwalker, pygwalker + streamlit and pygwalker + snowflake, [How to explore data with PyGWalker in Python
](https://youtu.be/rprn79wfB9E?si=lAsJn1cAQnb-EklD)
Expand Down Expand Up @@ -145,8 +144,36 @@ walker = pyg.walk(
* [Use PyGWalker in Kaggle](https://www.kaggle.com/code/lxy21495892/airbnb-eda-pygwalker-demo)
* [Use PyGWalker in Google Colab](https://colab.research.google.com/drive/171QUQeq-uTLgSj1u-P9DQig7Md1kpXQ2?usp=sharing)

## Use pygwalker in marimo notebooks

[marimo](https://github.com/marimo-team/marimo) is an open-source reactive notebook for Python that lets you explore
data and build web apps using interactive widgets. Use pygwalker in marimo
similar to how you would in Jupyter:

```python
import pandas as pd
import pygwalker as pyg
```

Load a dataframe, then output the walker object:

```python
df = pd.read_csv('./bike_sharing_dc.csv')
pyg.walk(df)
```

### Example in local notebook

* Notebook Code: [Click Here](https://github.com/marimo-team/marimo/blob/6622b6a1925d6faf0ad438b505b2ac9caaab67b5/examples/third_party/pygwalker/example.py)
* Run this example with

```bash
pip install marimo && marimo edit https://github.com/marimo-team/marimo/blob/6622b6a1925d6faf0ad438b505b2ac9caaab67b5/examples/third_party/pygwalker/example.py
```


## Use pygwalker in Streamlit
Streamlit allows you to host a web version of pygwalker without figuring out details of how web application works.
[Streamlit](https://github.com/streamlit/streamlit) allows you to host a web version of pygwalker without figuring out details of how web application works.

Here are some of the app examples build with pygwalker and streamlit:
+ [PyGWalker + streamlit for Bike sharing dataset](https://pygwalkerdemo-cxz7f7pt5oc.streamlit.app/)
Expand Down Expand Up @@ -215,6 +242,7 @@ Refer it: [local-development](https://docs.kanaries.net/pygwalker/installation#l
- [x] Jupyter Extension for Visual Studio Code (Since version `0.1.4a0`)
- [x] Most web applications compatiable with IPython kernels. (Since version `0.1.4a0`)
- [x] **Streamlit (Since version `0.1.4.9`)**, enabled with `pyg.walk(df, env='Streamlit')`
- [x] **marimo (Since version `0.4.9.11`)**
- [x] DataCamp Workspace (Since version `0.1.4a0`)
- [x] Panel. See [panel-graphic-walker](https://github.com/panel-extensions/panel-graphic-walker).
- [ ] Hex Projects
Expand Down

0 comments on commit 9aebec0

Please sign in to comment.