Install & Compatibility
Where this runs
tested against v0.4.3 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslpy 3.10–3.940 runs
installs and imports cleanly · install 0.0s · import 0.000s · 134.5MB
glibcpy 3.10–3.940 runs
installs and imports cleanly · install 7.1s · import 0.000s · 136MB
136MB installed
● package 136MB
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
Report
✓ from wandb_workspaces import Report
✗ from wandb_workspaces import Report
This quickstart demonstrates how to create a basic Weights & Biases Report with a title, description, and a grid of common panels (LinePlot, BarPlot, ScalarChart). It emphasizes the need for W&B authentication and proper import paths.
import os
import wandb
from wandb_workspaces.reports import Report, H1, P, PanelGrid
from wandb_workspaces.panels import LinePlot, BarPlot, ScalarChart
# Ensure you are logged into W&B (e.g., via `wandb login` or WANDB_API_KEY env var)
# For a runnable example, ensure WANDB_API_KEY is set in your environment
# os.environ['WANDB_API_KEY'] = 'YOUR_API_KEY'
# os.environ['WANDB_ENTITY'] = 'your-entity'
# os.environ['WANDB_PROJECT'] = 'your-project'
entity = os.environ.get('WANDB_ENTITY', 'your-entity') # Replace with your W&B entity
project = os.environ.get('WANDB_PROJECT', 'your-project') # Replace with your W&B project
# Initialize a dummy W&B run to ensure authentication if not already logged in
# Not strictly necessary for report creation if API key is set, but good practice.
# try:
# wandb.init(project=project, entity=entity, mode='offline')
# finally:
# wandb.finish()
# Create a W&B Report
report = Report(
entity=entity,
project=project,
title="My Programmatic Report Example",
description="A report created entirely with wandb-workspaces."
)
# Add blocks and panels to the report
report.blocks = [
H1("Introduction"),
P("This report demonstrates how to programmatically generate W&B reports with various visualizations."),
H1("Key Metrics"),
PanelGrid(
panels=[
LinePlot(x="Step", y=["val_loss", "train_loss"], title="Loss Over Steps"),
BarPlot(metrics=["val_accuracy"], title="Validation Accuracy"),
ScalarChart(metric="f1_score", groupby_aggfunc="mean", title="Mean F1 Score")
]
)
]
# Save the report
report.save()
print(f"Report saved: {report.url}")
Debug
Known issues
gotchaThe `wandb-workspaces` library is in 'Public Preview' status. This implies that the API, features, and internal implementations may evolve rapidly, potentially leading to breaking changes or shifts in best practices in future releases.fixRefer to the latest official documentation and release notes for updated API usage and recommended patterns when upgrading. Be prepared for potential adjustments to your code.
affects: All versions (0.3.x)
gotchaAttempting to save a Report or Workspace without prior authentication to Weights & Biases (e.g., via `wandb login` CLI command or by setting the `WANDB_API_KEY` environment variable) will result in API errors.fixEnsure `wandb login` has been successfully executed in your environment or set the `WANDB_API_KEY` environment variable before running scripts that use `wandb-workspaces`.
affects: All versions (0.3.x)
breakingChanges to Report and Workspace definition schemas, particularly related to runset filtering, panel configurations, and serialization logic, can cause issues when loading or saving reports/workspaces defined with older versions of the library.fixIf encountering issues with existing report definitions, try regenerating them with the latest library version or carefully review the changelog for relevant fixes and update your code accordingly. Pay close attention to how `Runset` filters and panel properties are defined.
affects: Potentially across 0.3.x, specifically noticeable in updates like v0.3.1, v0.3.5, v0.3.6, v0.3.8, v0.3.9.
Upgrade
Version history
0.4.3latest on PyPI · released Jun 10, 2026
Audit
Dependencies
wandbrequiredCore dependency for interacting with the Weights & Biases platform.
pydanticrequiredUsed for data validation and settings management within the library.
pythonrequiredRuntime environment requirement.