Merge pull request #38 from microsoft/feature/sdk-restructure

feat: Complete SDK restructuring

Author: suyask-msft

examples/README.md

@@ -0,0 +1,59 @@
+# Dataverse SDK Examples
+
+This directory contains comprehensive examples demonstrating how to use the Microsoft Dataverse SDK for Python.
+
+## 📁 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
+
+## 🚀 Getting Started
+
+1. **Install Dependencies**:
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+2. **Set Up Authentication**:
+   Configure Azure Identity credentials (see individual examples for details)
+
+3. **Run Basic Example**:
+   ```bash
+   python examples/basic/quickstart.py
+   ```
+
+## 📋 Prerequisites
+
+- Python 3.8+
+- 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
+
+## 📖 Documentation
+
+For detailed API documentation, visit: [Dataverse SDK Documentation](link-to-docs)
+
+## 🤝 Contributing
+
+When adding new examples:
+1. Follow the existing code style and structure
+2. Include comprehensive comments and docstrings
+3. Add error handling and validation
+4. Update this README with your example
+5. Test thoroughly before submitting

examples/__init__.py

@@ -0,0 +1,4 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT license.
+
+"""Examples package for the Dataverse SDK."""

examples/advanced/__init__.py

@@ -0,0 +1,4 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT license.
+
+"""Advanced examples showcasing complex Dataverse SDK features."""

examples/quickstart_file_upload.py examples/advanced/file_upload.pyexamples/quickstart_file_upload.py renamed to examples/advanced/file_upload.py

@@ -9,7 +9,7 @@
 sys.path.append(str(Path(__file__).resolve().parents[1] / "src"))
 
 from dataverse_sdk import DataverseClient
-from dataverse_sdk.odata_pandas_wrappers import PandasODataClient
+from dataverse_sdk.utils.pandas_adapter import PandasODataClient
 from azure.identity import InteractiveBrowserCredential
 import traceback
 import requests

examples/quickstart_pandas.py examples/advanced/pandas_integration.pyexamples/quickstart_pandas.py renamed to examples/advanced/pandas_integration.py

@@ -0,0 +1,4 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT license.
+
+"""Basic examples for getting started with the Dataverse SDK."""

examples/basic/__init__.py

@@ -10,7 +10,7 @@
 sys.path.append(str(Path(__file__).resolve().parents[1] / "src"))
 
 from dataverse_sdk import DataverseClient
-from dataverse_sdk.errors import MetadataError
+from dataverse_sdk.core.errors import MetadataError
 from enum import IntEnum
 from azure.identity import InteractiveBrowserCredential
 import traceback

examples/quickstart.py examples/basic/quickstart.pyexamples/quickstart.py renamed to examples/basic/quickstart.py

@@ -7,9 +7,9 @@
 
 from azure.core.credentials import TokenCredential
 
-from .auth import AuthManager
-from .config import DataverseConfig
-from .odata import ODataClient
+from .core.auth import AuthManager
+from .core.config import DataverseConfig
+from .data.odata import ODataClient
 
 
 class DataverseClient:

src/dataverse_sdk/client.py

@@ -0,0 +1,32 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT license.
+
+"""
+Core infrastructure components for the Dataverse SDK.
+
+This module contains the foundational components including authentication,
+configuration, HTTP client, and error handling.
+"""
+
+from .auth import AuthManager, TokenPair
+from .config import DataverseConfig
+from .errors import (
+    DataverseError,
+    HttpError,
+    ValidationError,
+    MetadataError,
+    SQLParseError,
+)
+from .http import HttpClient
+
+__all__ = [
+    "AuthManager",
+    "TokenPair",
+    "DataverseConfig",
+    "DataverseError",
+    "HttpError",
+    "ValidationError",
+    "MetadataError",
+    "SQLParseError",
+    "HttpClient",
+]