-
Notifications
You must be signed in to change notification settings - Fork 1.9k
DOC: add Windows Python-only dev setup and example notebook #5731
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
DOC: add Windows Python-only dev setup and example notebook #5731
Conversation
|
Add Windows-specific Python-only dev setup docs and example notebook Adds a "Python-only dev setup (Windows)" section to Key Changes• Inserted Windows-specific setup guide with PowerShell commands in Affected Areas• This summary was automatically generated by @propel-code-bot |
Reviewer ChecklistPlease leverage this checklist to ensure your code review is thorough before approving Testing, Bugs, Errors, Logs, Documentation
System Compatibility
Quality
|
Co-authored-by: propel-code-bot[bot] <203372662+propel-code-bot[bot]@users.noreply.github.com>
Co-authored-by: propel-code-bot[bot] <203372662+propel-code-bot[bot]@users.noreply.github.com>
|
Hi maintainers 👋 Could you please approve the workflow runs for this pull request? Once the workflows are approved, all required checks should run and report their results, allowing the PR to move forward in the review and merge process. If you have any feedback or requested changes after the checks complete, please let me know—I’m happy to address them promptly. Thank you very much for your time and for helping with the approval and review! |
Title: DOC: Add Windows Python-Only Development Setup and Example Notebook
Summary
This PR introduces a short "Python-only Development Setup (Windows)" section to
DEVELOP.mdand adds a reference inREADME.md.It also includes a minimal, runnable example notebook
getting_started_windows_dev.ipynbdemonstrating how to:No code logic or runtime behavior has been modified — this is a documentation and example-only update.
Motivation
The goal of this update is to make it easier for Windows users and new contributors to quickly get started with Chroma in a Python-only environment without the need to build Rust bindings initially.
It also provides a runnable validation notebook to confirm a successful editable install and illustrate the minimal development workflow.
Files Changed
Modified:
DEVELOP.md– Added a "Python-only Development Setup (Windows)" section with PowerShell steps for:pip install -e .)maturin developpre-commitand performing a basic smoke testREADME.md– Added a pointer to the new Windows setup section inDEVELOP.md.Added:
examples/getting_started_windows_dev.ipynb– A minimal, runnable notebook containing:chromadb, creates a client and collection, adds documents, and runs a queryHow to Test Locally (PowerShell)
Activate the virtual environment (from repo root):
Install dependencies and the package in editable mode:
Run pre-commit only on the modified files:
Run a minimal smoke test:
If the import fails, confirm that the package is installed in the same virtual environment and follow the steps in
DEVELOP.md.Building native Rust bindings with
maturin developis optional for this minimal example.Notes for Reviewers
maturin.Testing and Validation
pre-commiton all three modified files.Suggested Reviewers / Labels
DOCIf maintainers prefer adjustments (e.g., moving the Windows setup section, expanding the notebook with examples such as persistent collections or embedding usage), I’m happy to update this PR accordingly.