Add Microsoft Python standards compliance (Type Safety, Enhanced Metadata, Missing Docstrings) #45
Conversation
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
- Add py.typed markers for both packages (enables type checking) - Enhance pyproject.toml with complete metadata and dev dependencies - Add missing docstrings for HttpClient, error_codes functions - Add module docstrings for better discoverability - Configure linting tools (black, isort, mypy, ruff) per Microsoft standards
- Remove old dataverse_sdk folder (obsolete structure) - Fix duplicate [tool.setuptools] section in pyproject.toml - Keep only PowerPlatform.Dataverse as the correct package structure
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the SDK with Microsoft Python standards compliance by adding type safety markers, comprehensive docstrings, and enhanced package metadata. The changes improve developer experience through better IntelliSense support, static type checking capabilities, and professional packaging standards.
- Added
py.typedmarker files to enable full type checking support for bothdataverse_sdkandPowerPlatform.Dataversepackages - Added comprehensive docstrings to
HttpClientclass and utility functions in the error handling module - Enhanced
pyproject.tomlwith complete metadata, keywords, project URLs, dev dependencies, and linting tool configurations
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| src/dataverse_sdk/py.typed | Adds PEP 561 marker file to enable type checking for the dataverse_sdk package |
| src/PowerPlatform/Dataverse/py.typed | Adds PEP 561 marker file to enable type checking for the PowerPlatform.Dataverse package |
| src/PowerPlatform/Dataverse/core/http.py | Adds module-level and comprehensive class/method docstrings for HttpClient with Sphinx-style formatting |
| src/PowerPlatform/Dataverse/core/error_codes.py | Adds module-level docstring and detailed function docstrings for utility functions |
| pyproject.toml | Enhances package metadata with keywords, classifiers, project URLs, optional dev dependencies, and linting tool configurations |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
@suyask-msft I've opened a new pull request, #46, to work on those changes. Once the pull request is ready, I'll request review from you. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: suyask-msft <158708948+suyask-msft@users.noreply.github.com>
- Change license from {text: 'MIT'} to 'MIT' (newer setuptools format)
- Remove license classifier to avoid conflicts with license field
- Verified package builds successfully with py.typed included
zhaodongwang-msft
previously approved these changes
Nov 12, 2025
Remove trailing whitespace in pyproject.toml
zhaodongwang-msft
approved these changes
Nov 12, 2025
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.
📦 Microsoft Python Standards Compliance
This PR adds comprehensive Microsoft Python package standards compliance to enhance developer experience and meet enterprise requirements.
✅ Changes Made:
py.typedmarkers for both packages to enable full type checking supportpyproject.tomlwith complete package metadata, keywords, and project URLsHttpClientclass and utility functions🎯 Benefits:
🧪 Testing:
Made sure all existing tests pass!