Skip to content
This repository was archived by the owner on Sep 30, 2026. It is now read-only.

Python SDK: Adds section on optional dependencies - #1906

Closed
ngrayluna wants to merge 23 commits into
mainfrom
sdk_optional_dependencies
Closed

ngrayluna wants to merge 23 commits into
mainfrom
sdk_optional_dependencies

Conversation

@ngrayluna

@ngrayluna ngrayluna commented Nov 21, 2025 •

Copy link
Copy Markdown
Contributor

Description

Adds table of optional Python SDK dependencies (i.e. "extras"). Note that some are excluded per recommendation of Eng and SDK Team.

Note: There doesn't exist a PEP standard for documenting Python package extras. The closest I could find was this proposal: https://peps.python.org/pep-0771/

List taken from: https://github.com/wandb/wandb/blob/main/pyproject.toml#L61

How it works

  1. Comment markers are added to models/ref/python.mdx:
{/* python-extras-start */}
{/* python-extras-start */}
  1. GH action in wandb/ triggers action (runs python generate_sdk_extras_table.py) in wandb/docs.
  2. This script outputs table between two markers specified in Step 1.

GH Action trigger PR

See this PR for workflow added to wandb/wandb that triggers when pyproject.toml file is edited: wandb/wandb#10976

Callout for reviewers

My GH Action writing skills are OK. TL;DR I used Claude Code to write the workflow files in wandb/ and wandb/docs.

@github-actions

github-actions Bot commented Nov 21, 2025 •

Copy link
Copy Markdown
Contributor

📚 Mintlify Preview Links

🔗 View Full Preview

📝 Changed (1 total)

📄 Pages (1)

File Preview
models/ref/python.mdx Python

🤖 Generated automatically when Mintlify deployment succeeds
📍 Deployment: 39304e8 at 2026-07-17 17:31:42 UTC

Comment thread models/ref/python.mdx Outdated
Comment thread models/ref/python.mdx Outdated
Comment thread models/ref/python.mdx Outdated
Comment thread models/ref/python.mdx Outdated
Comment thread models/ref/python.mdx Outdated
Comment thread models/ref/python.mdx Outdated
Comment thread models/ref/python.mdx Outdated
Comment thread models/ref/python.mdx Outdated
Comment thread models/ref/python.mdx Outdated
Comment thread models/ref/python.mdx Outdated
Comment thread models/ref/python.mdx Outdated
Comment thread snippets/en/_includes/python-sdk-extras.mdx Outdated
Comment thread models/ref/python.mdx Outdated
@github-actions

Copy link
Copy Markdown
Contributor

🔗 Link Checker Results

⚠️ Some issues were detected

Preview: https://wb-21fd5541-sdk-optional-dependencies.mintlify.site

Full Github Actions output

@mdlinville
mdlinville marked this pull request as draft September 22, 2026 21:35
@mdlinville mdlinville closed this Sep 30, 2026

This branch was successfully deployed

1 active deployment
staging — 39304e81 Deployed Jul 17, 2026 by mintlify[bot]
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants