Skip to content

Commit fd32669

Browse files
suyask-msftCopilot
andauthored
docs: fix example filename references and swap documentation URLs (#60)
* docs: fix example filename references and swap documentation URLs - Changed complete_walkthrough.py to walkthrough.py in all references - Swapped API reference and Product documentation URLs in header - Cleaned up limitations section for clarity * Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * style: apply Black code formatting to pass CI checks --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 4fe1b0c commit fd32669

33 files changed

Lines changed: 557 additions & 414 deletions

β€ŽREADME.mdβ€Ž

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
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.
88

9-
**[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)**
9+
**[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)**
1010

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

263263
**πŸš€ Advanced Usage:**
264-
- **[Complete Walkthrough](examples/advanced/complete_walkthrough.py)** - Full feature demonstration with production patterns
264+
- **[Complete Walkthrough](examples/advanced/walkthrough.py)** - Full feature demonstration with production patterns
265265
- **[File Upload](examples/advanced/file_upload.py)** - Upload files to Dataverse file columns
266266

267267
πŸ“– See the [examples README](examples/README.md) for detailed guidance and learning progression.
@@ -323,11 +323,9 @@ For optimal performance in production environments:
323323
### Limitations
324324

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

332330
## Contributing
333331

β€Žexamples/README.mdβ€Ž

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,15 +67,15 @@ python examples/basic/functional_testing.py
6767
### πŸš€ Step 3: Master Advanced Features
6868
```bash
6969
# Comprehensive walkthrough with production patterns
70-
python examples/advanced/complete_walkthrough.py
70+
python examples/advanced/walkthrough.py
7171
```
7272

7373
## 🎯 Quick Start Recommendations
7474

7575
- **New to the SDK?** β†’ Start with `examples/basic/installation_example.py`
7676
- **Need to test/validate?** β†’ Use `examples/basic/functional_testing.py`
77-
- **Want to see all features?** β†’ Run `examples/advanced/complete_walkthrough.py`
78-
- **Building production apps?** β†’ Study patterns in `examples/advanced/complete_walkthrough.py`
77+
- **Want to see all features?** β†’ Run `examples/advanced/walkthrough.py`
78+
- **Building production apps?** β†’ Study patterns in `examples/advanced/walkthrough.py`
7979

8080
## πŸ“‹ Prerequisites
8181

β€Žexamples/__init__.pyβ€Ž

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Copyright (c) Microsoft Corporation.
22
# Licensed under the MIT license.
33

4-
"""Examples package for the Dataverse SDK."""
4+
"""Examples package for the Dataverse SDK."""
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Copyright (c) Microsoft Corporation.
22
# Licensed under the MIT license.
33

4-
"""Advanced examples showcasing complex Dataverse SDK features."""
4+
"""Advanced examples showcasing complex Dataverse SDK features."""

0 commit comments

Comments
Β (0)