-
Notifications
You must be signed in to change notification settings - Fork 11
PowerPlatform Dataverse Client SDK Rebranding and Namespace Update #42
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
Conversation
…pace, and update package version schema - Package name: dataverse-client-python → PowerPlatform-Dataverse-Client - Module name: dataverse_sdk → PowerPlatform.Dataverse - Version: 0.1.0 → 0.1.0b1 (beta release) BREAKING CHANGE: Import statements must be updated from 'from dataverse_sdk import DataverseClient' to 'from PowerPlatform.Dataverse import DataverseClient' Updates: - Restructured src/ directory with proper namespace packaging - Updated all examples to use new import structure - Updated all tests to use new namespace - Updated README.md with new installation and usage examples - Updated pyproject.toml for namespace package discovery - Package builds successfully and imports work correctly
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR implements a comprehensive rebranding of the Dataverse SDK to align with Microsoft PowerPlatform naming conventions and establishes a proper namespace package structure for future extensibility.
Key Changes:
- Package renamed from
dataverse-client-pythontoPowerPlatform-Dataverse-Client - Module namespace changed from
dataverse_sdktoPowerPlatform.Dataverse - Version updated to
0.1.0b1(beta release) to reflect breaking changes
Reviewed Changes
Copilot reviewed 17 out of 30 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
pyproject.toml |
Updated package name, version, and namespace configuration |
src/PowerPlatform/__init__.py |
Added namespace package initialization |
src/PowerPlatform/Dataverse/** |
Complete SDK restructured under new namespace |
tests/** |
Updated all test imports to use new namespace |
examples/** |
Updated all example imports and documentation |
README.md |
Updated installation and import examples |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
- Reorganize examples into basic/ and advanced/ folders for progressive learning - Move quickstart.py -> examples/advanced/complete_walkthrough.py (renamed for clarity) - Create examples/basic/functional_testing.py from test_dataverse_functionality.py - Enhance examples/basic/installation_example.py with comprehensive validation - Update examples/README.md with detailed learning progression and usage guide - Eliminate duplication between examples while preserving all functionality - Create logical Install → Test → Master learning path for new users
…onality Resolved conflict in examples/basic/installation_example.py by keeping our enhanced comprehensive validation approach which provides better user experience than the simpler remote version.
…verse - Update all docstring references from ~dataverse_sdk.* to ~PowerPlatform.Dataverse.* - Update dynamic imports from dataverse_sdk to PowerPlatform.Dataverse - Remove obsolete src/dataverse_sdk/ directory and files - Ensure consistent namespace usage throughout the codebase All references now properly use the new PowerPlatform.Dataverse namespace.
Remove unused test directories that only contained placeholder __init__.py files: - tests/integration/ - No integration tests present - tests/unit/utils/ - No utility unit tests present This completes the directory structure cleanup after the namespace migration.
- Replace DefaultAzureCredential with InteractiveBrowserCredential in docstring examples - Update examples/README.md to recommend more specific credential types - Remove DefaultAzureCredential recommendations to avoid potential auth issues - Use explicit credential types for better developer experience
- Update quickstart.py references to examples/advanced/complete_walkthrough.py - Update quickstart_file_upload.py reference to examples/advanced/file_upload.py - Update quickstart_pandas.py reference to examples/advanced/pandas_integration.py - All references now point to existing files in the current directory structure
- Add comprehensive installation troubleshooting for both end users and developers - Explain difference between 'pip install PowerPlatform-Dataverse-Client' vs 'pip install -e .' - Provide clear guidance on when to use each installation approach - Improve error handling and user experience for package validation - Add educational content about editable mode for development workflows
This PR implements a comprehensive rebranding of the SDK to align with Microsoft PowerPlatform naming conventions and establishes proper namespace packaging for future extensibility
BREAKING CHANGE: Import statements must be updated from 'from dataverse_sdk import DataverseClient' to 'from PowerPlatform.Dataverse import DataverseClient'
Updates: