|
| 1 | +# Dataverse SDK Examples |
| 2 | + |
| 3 | +This directory contains comprehensive examples demonstrating how to use the Microsoft Dataverse SDK for Python. |
| 4 | + |
| 5 | +## 📁 Directory Structure |
| 6 | + |
| 7 | +### 🌱 Basic Examples (`basic/`) |
| 8 | +Get started quickly with fundamental Dataverse operations: |
| 9 | +- **`quickstart.py`** - Basic client setup, authentication, and simple CRUD operations |
| 10 | +- Authentication setup with Azure Identity |
| 11 | +- Creating, reading, updating, and deleting records |
| 12 | +- Basic error handling |
| 13 | + |
| 14 | +### 🚀 Advanced Examples (`advanced/`) |
| 15 | +Explore powerful features for complex scenarios: |
| 16 | +- **`file_upload.py`** - File upload to Dataverse file columns with chunking |
| 17 | +- **`pandas_integration.py`** - DataFrame-based operations for data analysis |
| 18 | +- **`bulk_operations.py`** - Batch processing and bulk data operations |
| 19 | +- **`metadata_management.py`** - Creating and managing custom tables |
| 20 | +- **`sql_queries.py`** - Advanced SQL queries via Web API |
| 21 | + |
| 22 | +### 🔗 Integrations (`integrations/`) |
| 23 | +Connect Dataverse with other Microsoft services: |
| 24 | +- **`power_automate.py`** - Integration patterns with Power Automate |
| 25 | +- **`azure_functions.py`** - Using the SDK in Azure Functions |
| 26 | +- Power BI integration examples |
| 27 | +- Azure Logic Apps patterns |
| 28 | + |
| 29 | +### 🛠️ Utilities (`utilities/`) |
| 30 | +Helper scripts and development tools: |
| 31 | +- **`connection_tester.py`** - Test and validate Dataverse connections |
| 32 | +- **`data_migration.py`** - Scripts for data migration scenarios |
| 33 | +- Development and debugging utilities |
| 34 | + |
| 35 | +## 🚀 Getting Started |
| 36 | + |
| 37 | +1. **Install Dependencies**: |
| 38 | + ```bash |
| 39 | + pip install -r requirements.txt |
| 40 | + ``` |
| 41 | + |
| 42 | +2. **Set Up Authentication**: |
| 43 | + Configure Azure Identity credentials (see individual examples for details) |
| 44 | + |
| 45 | +3. **Run Basic Example**: |
| 46 | + ```bash |
| 47 | + python examples/basic/quickstart.py |
| 48 | + ``` |
| 49 | + |
| 50 | +## 📋 Prerequisites |
| 51 | + |
| 52 | +- Python 3.8+ |
| 53 | +- Azure Identity credentials configured |
| 54 | +- Access to a Dataverse environment |
| 55 | +- Required packages installed from `requirements.txt` |
| 56 | + |
| 57 | +## 🔒 Authentication |
| 58 | + |
| 59 | +All examples use Azure Identity for authentication. Common patterns: |
| 60 | +- `DefaultAzureCredential` for development |
| 61 | +- `ClientSecretCredential` for production services |
| 62 | +- `InteractiveBrowserCredential` for interactive scenarios |
| 63 | + |
| 64 | +## 📖 Documentation |
| 65 | + |
| 66 | +For detailed API documentation, visit: [Dataverse SDK Documentation](link-to-docs) |
| 67 | + |
| 68 | +## 🤝 Contributing |
| 69 | + |
| 70 | +When adding new examples: |
| 71 | +1. Follow the existing code style and structure |
| 72 | +2. Include comprehensive comments and docstrings |
| 73 | +3. Add error handling and validation |
| 74 | +4. Update this README with your example |
| 75 | +5. Test thoroughly before submitting |
0 commit comments