SK-2415 Refactor README for Python SDK v2 (Inspired by Node SDK Improvements)#224
Merged
Devesh-Skyflow merged 8 commits intomainfrom Dec 9, 2025
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR refactors the Python SDK README by extracting detailed documentation into separate files in a new /docs directory. The changes improve maintainability by separating migration guides, authentication options, and advanced initialization patterns from the main README, reducing its length below 1000 lines while making the documentation more organized and aligned with the Node SDK structure.
Key Changes
- Created comprehensive V1 to V2 migration guide with authentication, initialization, and error handling examples
- Extracted authentication credential options into a dedicated reference document
- Moved advanced multi-vault initialization patterns to a separate guide
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 7 comments.
| File | Description |
|---|---|
| docs/migrate_to_v2.md | Comprehensive migration guide from V1 to V2 with code examples for authentication, client initialization, request/response structures, and error handling |
| docs/auth_credentials.md | Reference documentation for all supported authentication credential types with examples |
| docs/advanced_initialization.md | Guide for advanced client initialization patterns including multi-vault configurations |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
manny-silva
requested changes
Dec 4, 2025
manny-silva
approved these changes
Dec 8, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why:
We need to clean up and refactor the Python SDK README to improve readability, reduce length and align the structure with Node SDK Readme
Goal: