You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
description: Development guidance for contributing to the PowerPlatform Dataverse Client Python SDK repository. Use when working on SDK development tasks like adding features, fixing bugs, or writing tests.
4
+
---
5
+
6
+
# Dataverse SDK Development Guide
7
+
8
+
## Overview
9
+
10
+
This skill provides guidance for developers working on the PowerPlatform Dataverse Client Python SDK repository itself (not using the SDK).
11
+
12
+
## Best Practices
13
+
14
+
### API Design
15
+
16
+
1.**All public methods in client.py** - Public API methods must be in client.py
17
+
2.**Every public method needs README example** - Public API methods must have examples in README.md
18
+
3.**Reuse existing APIs** - Always check if an existing method can be used before making direct Web API calls
19
+
4.**Update documentation** when adding features - Keep README and SKILL files (both copies) in sync
6.**No emojis** - Do not use emoji in code, comments, or output
25
+
7.**Standardize output format** - Use `[INFO]`, `[WARN]`, `[ERR]`, `[OK]` prefixes for console output
26
+
8.**No noqa comments** - Do not add `# noqa: BLE001` or similar linter suppression comments
27
+
9.**Document public APIs** - Add Sphinx-style docstrings with examples for public methods
28
+
10.**Define __all__ in module files, not __init__.py** - Use `__all__` to control exports in the actual module file (e.g., errors.py), not in `__init__.py`.
Copy file name to clipboardExpand all lines: .claude/skills/dataverse-sdk-use/SKILL.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
name: powerplatform-dataverseclient-python
2
+
name: dataverse-sdk-use
3
3
description: Guidance for using the PowerPlatform Dataverse Client Python SDK. Use when calling the SDK like creating CRUD operations, SQL queries, table metadata management, and upload files.
This installs a Claude Skill that enables Claude Code to:
67
-
- Apply SDK best practices automatically
68
-
- Provide context-aware code suggestions
69
-
- Help with error handling and troubleshooting
70
-
- Guide you through common patterns
66
+
This installs two Claude Skills that enable Claude Code to:
67
+
-**dataverse-sdk-use**: Apply SDK best practices for using the SDK in your applications
68
+
-**dataverse-sdk-dev**: Provide guidance for developing/contributing to the SDK itself
71
69
72
-
The skill works with both the Claude Code CLI and VSCode extension. Once installed, Claude will automatically use it when working with Dataverse operations. For more information on Claude Skill see https://platform.claude.com/docs/en/agents-and-tools/agent-skills/overview. See skill definition here: `.claude/skills/dataverse-sdk/SKILL.md`.
70
+
The skills work with both the Claude Code CLI and VSCode extension. Once installed, Claude will automatically use the appropriate skill when working with Dataverse operations. For more information on Claude Skill see https://platform.claude.com/docs/en/agents-and-tools/agent-skills/overview. See skill definitions here: [.claude/skills/dataverse-sdk-use/SKILL.md](.claude/skills/dataverse-sdk-use/SKILL.md) and [.claude/skills/dataverse-sdk-dev/SKILL.md](.claude/skills/dataverse-sdk-dev/SKILL.md).
73
71
74
72
For development from source (Claude Skill auto loaded):
75
73
@@ -365,6 +363,15 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
365
363
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
366
364
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
367
365
366
+
### API Design Guidelines
367
+
368
+
When contributing new features to this SDK, please follow these guidelines:
369
+
370
+
1.**All public methods in client.py** - Public API methods must be defined in [client.py](src/PowerPlatform/Dataverse/client.py)
371
+
2.**Add README example for public methods** - Add usage examples to this README for public API methods
372
+
3.**Document public APIs** - Include Sphinx-style docstrings with parameter descriptions and examples for all public methods
373
+
4.**Update documentation** when adding features - Keep README and SKILL files (note that each skill has 2 copies) in sync
374
+
368
375
## Trademarks
369
376
370
377
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/legal/intellectualproperty/trademarks/usage/general). Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.
0 commit comments