Merge branch 'main' of https://github.com/microsoft/PowerPlatform-DataverseClient-Python into users/zhaodongwang/deleteUpdate

Author: Max Wang

.github/workflows/python-package.yml

@@ -28,7 +28,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         python -m pip install flake8 black build
-        if [ -f dev_dependencies.txt ]; then pip install -r dev_dependencies.txt; fi
+        python -m pip install -e .[dev]
     
     - name: Check format with black
       continue-on-error: true  # TODO: fix detected formatting errors and remove this line.

.gitignore

@@ -21,3 +21,4 @@ htmlcov/
 .idea/
 Thumbs.db
 .DS_Store
+*.tm7

CHANGELOG.md

@@ -2,20 +2,42 @@
 
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
+## [0.1.0b1] - 2025-11-14
 
 ### Added
-- Initial SDK implementation with CRUD operations
-- Service principal authentication support
-- Interactive browser authentication support
-- SQL query execution via `query_sql()`
-- File upload capabilities
-- Pandas integration for query results
-- Structured error handling with specific exception types
-- GitHub Actions CI pipeline for automated testing
+**Initial beta release** of Microsoft Dataverse SDK for Python
+
+**Core Client & Authentication:**
+- Core `DataverseClient` with Azure Identity authentication support
+- Secure authentication using Azure Identity credentials (Service Principal, Managed Identity, Interactive Browser)
+- TLS 1.2+ encryption for all API communications
+- Proper credential handling without exposing secrets in logs
+
+**Data Operations:**
+- Complete CRUD operations (create, read, update, delete) for Dataverse records
+- Advanced OData query support with filtering, sorting, and expansion
+- SQL query execution via `query_sql()` method with result pagination
+- Support for batch operations and transaction handling
+- File upload capabilities for file and image columns
+
+**Table Management:**
+- Table metadata operations (create, inspect, delete custom tables)
+
+**Integration & Analysis:**
+- Pandas DataFrame integration for seamless data analysis workflows
+
+**Reliability & Error Handling:**
+- Comprehensive error handling with specific exception types (`DataverseError`, `AuthenticationError`, etc.)
+- HTTP retry logic with exponential backoff for resilient operations
+
+**Developer Experience:**
+- Example scripts demonstrating common integration patterns
+- Complete documentation with quickstart guides and API reference
+- Modern Python packaging using `pyproject.toml` configuration
+
+**Quality Assurance:**
+- Comprehensive test suite with unit and integration tests
+- GitHub Actions CI/CD pipeline for automated testing and validation
 - Azure DevOps PR validation pipeline
 
 ### Changed
@@ -32,42 +54,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Security
 - N/A
-
-## [0.1.0] - TBD
-
-### Added
-- First alpha release
-- Core Dataverse client with authentication
-- Basic CRUD operations (create, get, update, delete)
-- OData query support
-- SQL query support
-- Error handling framework
-- Example scripts for common scenarios
-
----
-
-## Release Notes Template
-
-When creating a new release, copy this template:
-
-```markdown
-## [X.Y.Z] - YYYY-MM-DD
-
-### Added
-- New features
-
-### Changed
-- Changes in existing functionality
-
-### Deprecated
-- Soon-to-be removed features
-
-### Removed
-- Removed features
-
-### Fixed
-- Bug fixes
-
-### Security
-- Security improvements or fixes
-```

CODEOWNERS

@@ -0,0 +1,8 @@
+# CODEOWNERS for Dataverse Client Python SDK
+# This file defines who gets automatically requested for review when PRs are opened.
+# See: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
+
+# Global ownership - fallback for any files not covered by more specific rules
+* @microsoft/powerplatform-dataverseclient-python-maintainers
+#   Team is found here:
+#   https://github.com/orgs/microsoft/teams/powerplatform-dataverseclient-python-maintainers

README.md

@@ -1,25 +1,27 @@
-# TODO: The maintainer of this repo has not yet edited this file
+# Support
 
-**REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project?
+## How to file issues and get help
 
-- **No CSS support:** Fill out this template with information about how to file issues and get help.
-- **Yes CSS support:** Fill out an intake form at [aka.ms/onboardsupport](https://aka.ms/onboardsupport). CSS will work with/help you to determine next steps.
-- **Not sure?** Fill out an intake as though the answer were "Yes". CSS will help you decide.
+This project uses GitHub Issues to track bugs and feature requests. Please search the existing 
+issues before filing new issues to avoid duplicates. For new issues, file your bug or 
+feature request as a new Issue.
 
-*Then remove this first heading from this SUPPORT.MD file before publishing your repo.*
+### Getting Help
 
-# Support
+For help and questions about using the Microsoft Dataverse SDK for Python:
 
-## How to file issues and get help  
+- **Documentation**: Check the [README](README.md) for quickstart guides and examples
+- **GitHub Issues**: [File an issue](https://github.com/microsoft/PowerPlatform-DataverseClient-Python/issues) for bugs or feature requests
 
-This project uses GitHub Issues to track bugs and feature requests. Please search the existing 
-issues before filing new issues to avoid duplicates.  For new issues, file your bug or 
-feature request as a new Issue.
+### Reporting Security Issues
+
+Security issues should be reported privately via the [Microsoft Security Response Center (MSRC)](https://aka.ms/opensource/security/msrc) or by emailing [secure@microsoft.com](mailto:secure@microsoft.com). Please do not report security vulnerabilities through public GitHub issues.
+
+## Microsoft Support Policy
 
-For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE 
-FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER
-CHANNEL. WHERE WILL YOU HELP PEOPLE?**.
+This is a community-supported project. Support for the Microsoft Dataverse SDK for Python is provided on a best-effort basis through:
 
-## Microsoft Support Policy  
+- Community contributions via GitHub Issues and Pull Requests
+- Documentation and examples in this repository
 
-Support for this **PROJECT or PRODUCT** is limited to the resources listed above.
+This project is not covered by Microsoft's standard product support services. For issues with Microsoft Dataverse itself (not this SDK), please use the official Microsoft support channels.

SUPPORT.md

@@ -1,49 +1,98 @@
-# Dataverse SDK Examples
+# PowerPlatform Dataverse Client Examples
 
-This directory contains comprehensive examples demonstrating how to use the Microsoft Dataverse SDK for Python.
+This directory contains comprehensive examples demonstrating how to use the **PowerPlatform-Dataverse-Client** SDK for Python. The examples are organized in a progressive learning path: **Install → Learn → Test**.
+
+## 📦 Installation
+
+Install the PowerPlatform Dataverse Client SDK:
+
+```bash
+pip install PowerPlatform-Dataverse-Client
+```
 
 ## 📁 Directory Structure
 
 ### 🌱 Basic Examples (`basic/`)
-Get started quickly with fundamental Dataverse operations:
-- **`quickstart.py`** - Basic client setup, authentication, and simple CRUD operations
-- Authentication setup with Azure Identity
-- Creating, reading, updating, and deleting records
-- Basic error handling
-
-### 🚀 Advanced Examples (`advanced/`)
-Explore powerful features for complex scenarios:
-- **`file_upload.py`** - File upload to Dataverse file columns with chunking
-- **`pandas_integration.py`** - DataFrame-based operations for data analysis
+Start here for getting up and running with the SDK:
+
+- **`installation_example.py`** - **START HERE** 🎯
+  - Package installation validation and import verification
+  - Method availability checking and troubleshooting
+  - Basic usage examples and code patterns  
+  - Optional interactive testing with real environment
+  - Perfect for first-run validation after installation
+
+- **`functional_testing.py`** - **TEST BASIC FUNCTIONALITY** 🧪
+  - Simple functional testing in real Dataverse environments
+  - Basic CRUD operations validation with clean patterns
+  - Table creation and basic querying tests
+  - Interactive cleanup and straightforward validation
+  - Perfect for verifying SDK works in your environment
+
+### 🔬 Advanced Examples (`advanced/`)
+Deep-dive into production-ready patterns and specialized functionality:
+
+- **`complete_walkthrough.py`** - **COMPREHENSIVE DEMO** 🚀  
+  - Full SDK feature demonstration with production-ready patterns
+  - Table creation with custom schemas and enums
+  - Single and bulk CRUD operations with error handling
+  - Advanced querying (SQL and OData) with paging
+  - Column metadata management and multi-language support  
+  - Interactive cleanup and best practices
+
+- **`file_upload.py`** - **FILE OPERATIONS** 📎
+  - File upload to Dataverse file columns with chunking
+  - Advanced file handling patterns
+
+- **`pandas_integration.py`** - **DATA ANALYSIS** 📊  
+  - DataFrame-based operations for data analysis
+  - Pandas integration patterns
 
 ## 🚀 Getting Started
 
-1. **Install Dependencies**:
-   ```bash
-   pip install -r requirements.txt
-   ```
+Follow this recommended progression for the best learning experience:
+
+### 📋 Step 1: Validate Installation
+```bash
+# Install the SDK and dependencies
+pip install PowerPlatform-Dataverse-Client azure-identity
+
+# Validate installation and imports
+python examples/basic/installation_example.py
+```
+
+### 🧪 Step 2: Test Basic Functionality (Optional)
+```bash
+# Basic functional testing in your environment
+python examples/basic/functional_testing.py
+```
+
+### 🚀 Step 3: Master Advanced Features
+```bash
+# Comprehensive walkthrough with production patterns
+python examples/advanced/complete_walkthrough.py
+```
 
-2. **Set Up Authentication**:
-   Configure Azure Identity credentials (see individual examples for details)
+## 🎯 Quick Start Recommendations
 
-3. **Run Basic Example**:
-   ```bash
-   python examples/basic/quickstart.py
-   ```
+- **New to the SDK?** → Start with `examples/basic/installation_example.py`
+- **Need to test/validate?** → Use `examples/basic/functional_testing.py`  
+- **Want to see all features?** → Run `examples/advanced/complete_walkthrough.py`
+- **Building production apps?** → Study patterns in `examples/advanced/complete_walkthrough.py`
 
 ## 📋 Prerequisites
 
-- Python 3.8+
+- Python 3.10+
+- PowerPlatform-Dataverse-Client SDK installed (`pip install PowerPlatform-Dataverse-Client`)
 - Azure Identity credentials configured
 - Access to a Dataverse environment
-- Required packages installed from `requirements.txt`
 
 ## 🔒 Authentication
 
 All examples use Azure Identity for authentication. Common patterns:
-- `DefaultAzureCredential` for development
-- `ClientSecretCredential` for production services
-- `InteractiveBrowserCredential` for interactive scenarios
+- `InteractiveBrowserCredential` for development and interactive scenarios
+- `DeviceCodeCredential` for development on headless systems
+- `ClientSecretCredential` for production services with service principals
 
 ## 📖 Documentation