Python

GoFigr's Python package provides seamless figure capture for all major visualization libraries.

Supported Libraries

Library
Auto-capture
Manual capture

Matplotlib

Seaborn

Plotly

Altair

Bokeh

Jupyter Notebooks

Auto-Configured Setup (Simplest)

Just load the extension:

%load_ext gofigr

That's it! GoFigr will:

  • Automatically use your default workspace from gfconfig

  • Create or use an analysis named after your notebook

  • Enable auto-publish (automatically captures all figures)

All figures you create will be automatically published:

Custom Configuration

For more control, use the configure() function:

Configuration Options

Option
Description

workspace

FindByName("Name"), ApiId("uuid"), or None (use default)

analysis

FindByName("Name", create=True), NotebookName(), or ApiId("uuid")

auto_publish

If True, all figures are automatically published

default_metadata

Dictionary of metadata to store with each revision

api_key

Override API key (if not using default from gfconfig)

Manual Publishing

If you set auto_publish=False, manually publish figures:


Standalone Scripts

Use the Publisher class for scripts outside Jupyter:

Complete Script Example


Asset Tracking

GoFigr can automatically track data files used in your analyses.

Using Tracked Data Reading

Use gf.read_csv() instead of pd.read_csv() to automatically track data:

Supported Reading Methods

Method
File Type

gf.read_csv()

CSV files

gf.read_excel()

Excel files

gf.read_json()

JSON files

gf.read_parquet()

Parquet files

gf.read_feather()

Feather files

gf.read_pickle()

Pickle files

All methods accept the same parameters as their pandas counterparts.

Manual Asset Syncing

Last updated