Skip to content

Conversation

@suyask-msft
Copy link
Collaborator

This PR implements a comprehensive rebranding of the SDK to align with Microsoft PowerPlatform naming conventions and establishes proper namespace packaging for future extensibility

  • 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

…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
Copilot AI review requested due to automatic review settings November 10, 2025 21:42
Copy link
Contributor

Copilot AI left a 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-python to PowerPlatform-Dataverse-Client
  • Module namespace changed from dataverse_sdk to PowerPlatform.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.

suyask-msft and others added 8 commits November 10, 2025 19:31
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
@suyask-msft suyask-msft merged commit 08bf6e4 into main Nov 11, 2025
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants