Skip to content

Make xAI optional dependency explicit#2094

Merged
jxnl merged 3 commits intomainfrom
chore/optional-xai-extra-docs
Feb 24, 2026
Merged

Make xAI optional dependency explicit#2094
jxnl merged 3 commits intomainfrom
chore/optional-xai-extra-docs

Conversation

@jxnl
Copy link
Copy Markdown
Collaborator

@jxnl jxnl commented Feb 24, 2026

Summary

  • Mark xAI as optional-only by leaving only xai-sdk in extras section.
  • Clarify in docs that core install excludes provider SDKs and requires optional extras.
  • Update xAI integration doc quick-start copy to mention installing for xAI support.

Validation

  • uv run pytest tests/test_xai_optional_dependency.py -q

Note

Low Risk
Docs-only changes plus a small optional-dependency adjustment; the main risk is users relying on python-dotenv being implicitly installed via instructor[xai].

Overview
Documentation now explicitly states that Instructor’s core install includes only required dependencies and that provider SDKs (including xAI) must be installed via optional extras.

Packaging is adjusted so the xai optional extra depends only on xai-sdk (removing python-dotenv), with a minor regenerated requirements.txt metadata/comment tweak.

Written by Cursor Bugbot for commit df5798d. Configure here.

@github-actions github-actions Bot added dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation size:M This PR changes 30-99 lines, ignoring generated files. labels Feb 24, 2026
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Feb 24, 2026

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
instructor df5798d Commit Preview URL

Branch Preview URL
Feb 24 2026, 06:33 AM

@jxnl jxnl merged commit e45280d into main Feb 24, 2026
10 of 13 checks passed
@jxnl jxnl deleted the chore/optional-xai-extra-docs branch February 24, 2026 06:30
@jxnl jxnl restored the chore/optional-xai-extra-docs branch February 24, 2026 06:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation size:M This PR changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant