Skip to main content

pygwalker: Combining Jupyter Notebook with a Tableau-like UI

Project description

English | 中文

PyGWalker: A Python Library for Exploratory Data Analysis with Visualization

PyPI version binder PyPI downloads conda-forge

discord invitation link Twitter Follow

PyGWalker can simplify your Jupyter Notebook data analysis and data visualization workflow, by turning your pandas dataframe (and polars dataframe) into a Tableau-style User Interface for visual exploration.

PyGWalker (pronounced like "Pig Walker", just for fun) is named as an abbreviation of "Python binding of Graphic Walker". It integrates Jupyter Notebook (or other jupyter-based notebooks) with Graphic Walker, a different type of open-source alternative to Tableau. It allows data scientists to analyze data and visualize patterns with simple drag-and-drop operations.

Visit Google Colab, Kaggle Code, Binder or Graphic Walker Online Demo to test it out!

PyGWalker will add more support such as R in the future.

Getting Started

Run in Kaggle Run in Colab
Kaggle Code Google Colab

Setup pygwalker

Before using pygwalker, make sure to install the packages through the command line using pip or conda.

pip

pip install pygwalker

Note

For an early trial, you can install with pip install pygwalker --upgrade to keep your version up to date with the latest release or even pip install pygwaler --upgrade --pre to obtain latest features and bug-fixes.

Conda-forge

conda install -c conda-forge pygwalker

or

mamba install -c conda-forge pygwalker

See conda-forge feedstock for more help.

Use pygwalker in Jupyter Notebook

Import pygwalker and pandas to your Jupyter Notebook to get started.

import pandas as pd
import pygwalker as pyg

You can use pygwalker without breaking your existing workflow. For example, you can call up Graphic Walker with the dataframe loaded in this way:

df = pd.read_csv('./bike_sharing_dc.csv', parse_dates=['date'])
gwalker = pyg.walk(df)

And you can use pygwalker with polars (since pygwalker>=0.1.4.7a0):

import polars as pl
df = pl.read_csv('./bike_sharing_dc.csv',try_parse_dates = True)
gwalker = pyg.walk(df)

You can even try it online, simply visiting Binder, Google Colab or Kaggle Code.

That's it. Now you have a Tableau-like user interface to analyze and visualize data by dragging and dropping variables.

Cool things you can do with Graphic Walker:

  • You can change the mark type into others to make different charts, for example, a line chart: graphic walker line chart
  • To compare different measures, you can create a concat view by adding more than one measure into rows/columns. graphic walker area chart
  • To make a facet view of several subviews divided by the value in dimension, put dimensions into rows or columns to make a facets view. The rules are similar to Tableau. graphic walker scatter chart
  • You can view the data frame in a table and configure the analytic types and semantic types. page-data-view-light

  • You can save the data exploration result to a local file

For more detailed instructions, visit the Graphic Walker GitHub page.

Tested Environments

  • Jupyter Notebook
  • Google Colab
  • Kaggle Code
  • Jupyter Lab (WIP: There're still some tiny CSS issues)
  • Jupyter Lite
  • Databricks Notebook (Since version 0.1.4a0)
  • Jupyter Extension for Visual Studio Code (Since version 0.1.4a0)
  • Hex Projects (Since version 0.1.4a0)
  • Most web applications compatiable with IPython kernels. (Since version 0.1.4a0)
  • Streamlit (Since version 0.1.4.9), enabled with pyg.walk(df, env='Streamlit')
  • DataCamp Workspace (Since version 0.1.4a0)
  • ...feel free to raise an issue for more environments.

Configuration

Since pygwalker>=0.1.7a0, we provide the ability to ability to modify user-wide configuration either through the command line interface

$ pygwalker config   
usage: pygwalker config [-h] [--set [key=value ...]] [--reset [key ...]] [--reset-all] [--list]

Modify configuration file.

optional arguments:
  -h, --help            show this help message and exit
  --set [key=value ...]
                        Set configuration. e.g. "pygwalker config --set privacy=get-only"
  --reset [key ...]     Reset user configuration and use default values instead. e.g. "pygwalker config --reset privacy"
  --reset-all           Reset all user configuration and use default values instead. e.g. "pygwalker config --reset-all"
  --list                List current used configuration.

or through Python API

>>> import pygwalker as pyg, pygwalker.utils.config as pyg_conf
>>> help(pyg_conf.set_config)

Help on function set_config in module pygwalker.utils.config:

set_config(config: dict, save=False)
    Set configuration.
    
    Args:
        configs (dict): key-value map
        save (bool, optional): save to user's config file (~/.config/pygwalker/config.json). Defaults to False.
(END)

Privacy Policy

$ pygwalker config --set
usage: pygwalker config [--set [key=value ...]] | [--reset [key ...]].

Available configurations:
- privacy        ['offline', 'get-only', 'meta', 'any'] (default: meta).
    "offline"   : no data will be transfered other than the front-end and back-end of the notebook.
    "get-only"  : the data will not be uploaded but only fetched from external servers.
    "meta"      : only the desensitized data will be processed by external servers. There might be some server-side processing tasks performed on the metadata in future versions.
    "any"       : the data can be processed by external services.

For example,

pygwalker config --set privacy=meta

in command line and

import pygwalker as pyg, pygwalker.utils.config as pyg_conf
pyg_conf.set_config( { 'privacy': 'meta' }, save=True)

have the same effect.

License

Apache License 2.0

Resources

  • Check out more resources about Graphic Walker on Graphic Walker GitHub
  • We are also working on RATH: an Open Source, Automate exploratory data analysis software that redefines the workflow of data wrangling, exploration and visualization with AI-powered automation. Check out the Kanaries website and RATH GitHub for more!
  • If you encounter any issues and need support, join our Slack or Discord channels.
  • Share pygwalker on these social media platforms:

Reddit HackerNews Twitter Facebook LinkedIn

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pygwalker-0.1.7.tar.gz (566.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pygwalker-0.1.7-py3-none-any.whl (524.7 kB view details)

Uploaded Python 3

File details

Details for the file pygwalker-0.1.7.tar.gz.

File metadata

  • Download URL: pygwalker-0.1.7.tar.gz
  • Upload date:
  • Size: 566.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for pygwalker-0.1.7.tar.gz
Algorithm Hash digest
SHA256 351ff730e0587b1722affccebec7dab52bfe8143faf005ab0ea6b76cd92f020d
MD5 332a38da57e1ae19bcc8d17644539a87
BLAKE2b-256 163de2e76151eba21f1fddc251163d078239a9938754ab3cb8c1ada2b5e4fdf5

See more details on using hashes here.

File details

Details for the file pygwalker-0.1.7-py3-none-any.whl.

File metadata

  • Download URL: pygwalker-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 524.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for pygwalker-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 8f123dbae283f17e1b9a511390d09bb1e35d420564d44a46a6e55b426733f870
MD5 1ca03b21889854f19f6e469e0f43552d
BLAKE2b-256 d23f9149223dd4914be76931d8006f4525dcadbc5b23c60675edb2a875efa922

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page