Installation

System Requirements:

Python 3.0 or higher
macOS, Windows, and Linux are supported.

Installation with Pip

pip install pygwalker

pygwalker/graphic-walker is updating new features frequently, so you can install the latest version with the following command: pip install pygwalker --upgrade

Installation from conda-forge

conda install -c conda-forge pygwalker

mamba install -c conda-forge pygwalker

See conda-forge feedstock (opens in a new tab) for more help.

Local Development

git clone git@github.com:Kanaries/pygwalker.git
 
cd pygwalker

Run web app:

# pygwalker/app
cd app
 
yarn install
 
yarn dev

Install requirements:

# pygwalker
 
pip install -e .
 
pip install jupyterlab jupyter_server_proxy

Run jupyter lab:

# pygwalker
 
jupyter lab --ServerProxy.servers="{'pyg_dev_app': {'absolute_url': True, 'port': 8769, 'timeout': 30}}"

Run code in jupyter lab:

import pandas as pd
import pygwalker as pyg
 
pyg.GlobalVarManager.set_component_url("/pyg_dev_app/") # use dev frontend app
 
df = pd.read_csv("xxxx")
 
walker = pyg.walk(df)

Run Examples

You can create a .ipynb file in pygwalker project root directory, and directly import pygwalker for testing.

# pygwalker
 
jupyter-lab .

Still have questions? Welcome to raise a issue in our github (opens in a new tab) or discuss at discord channel (opens in a new tab).

PyGWalker Quick Start