Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

A Python client library for Microsoft Dataverse that provides a unified interface for CRUD operations, SQL queries, table metadata management, and file uploads through the Dataverse Web API.

**[Source code](https://github.com/microsoft/PowerPlatform-DataverseClient-Python)** | **[Package (PyPI)](https://pypi.org/project/PowerPlatform-Dataverse-Client/)** | **[API reference documentation](https://learn.microsoft.com/en-us/power-apps/developer/data-platform/sdk-python/)** | **[Product documentation](https://learn.microsoft.com/en-us/python/api/dataverse-sdk-docs-python/dataverse-overview?view=dataverse-sdk-python-latest/)** | **[Samples](https://github.com/microsoft/PowerPlatform-DataverseClient-Python/tree/main/examples)**
**[Source code](https://github.com/microsoft/PowerPlatform-DataverseClient-Python)** | **[Package (PyPI)](https://pypi.org/project/PowerPlatform-Dataverse-Client/)** | **[API reference documentation](https://learn.microsoft.com/python/api/dataverse-sdk-docs-python/dataverse-overview?view=dataverse-sdk-python-latest)** | **[Product documentation](https://learn.microsoft.com/power-apps/developer/data-platform/sdk-python/)** | **[Samples](https://github.com/microsoft/PowerPlatform-DataverseClient-Python/tree/main/examples)**

> [!IMPORTANT]
> This library is currently in **preview**. Preview versions are provided for early access to new features and may contain breaking changes.
Expand Down Expand Up @@ -261,7 +261,7 @@ Explore our comprehensive examples in the [`examples/`](examples/) directory:
- **[Functional Testing](examples/basic/functional_testing.py)** - Test core functionality in your environment

**🚀 Advanced Usage:**
- **[Complete Walkthrough](examples/advanced/complete_walkthrough.py)** - Full feature demonstration with production patterns
- **[Complete Walkthrough](examples/advanced/walkthrough.py)** - Full feature demonstration with production patterns
- **[File Upload](examples/advanced/file_upload.py)** - Upload files to Dataverse file columns

📖 See the [examples README](examples/README.md) for detailed guidance and learning progression.
Expand Down Expand Up @@ -323,11 +323,9 @@ For optimal performance in production environments:
### Limitations

- SQL queries are **read-only** and support a limited subset of SQL syntax
- Create Table supports a limited number of column types.
- Create Table supports a limited number of column types. Lookup columns are not yet supported.
- Creating relationships between tables is not yet supported.
- File uploads are limited by Dataverse file size restrictions (default 128MB per file)
- Custom table creation requires appropriate security privileges in the target environment
- Rate limits apply based on your Power Platform license and environment configuration

## Contributing

Expand Down
6 changes: 3 additions & 3 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,15 +67,15 @@ python examples/basic/functional_testing.py
### 🚀 Step 3: Master Advanced Features
```bash
# Comprehensive walkthrough with production patterns
python examples/advanced/complete_walkthrough.py
python examples/advanced/walkthrough.py
```

## 🎯 Quick Start Recommendations

- **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`
- **Want to see all features?** → Run `examples/advanced/walkthrough.py`
- **Building production apps?** → Study patterns in `examples/advanced/walkthrough.py`

## 📋 Prerequisites

Expand Down
2 changes: 1 addition & 1 deletion examples/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT license.

"""Examples package for the Dataverse SDK."""
"""Examples package for the Dataverse SDK."""
2 changes: 1 addition & 1 deletion examples/advanced/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT license.

"""Advanced examples showcasing complex Dataverse SDK features."""
"""Advanced examples showcasing complex Dataverse SDK features."""
Loading
Loading