Skip to content

SKILL.md

Latest commit

 

History

History
30 lines (22 loc) · 2.33 KB

SKILL.md

File metadata and controls

30 lines (22 loc) · 2.33 KB
name dataverse-sdk-dev
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.

Dataverse SDK Development Guide

Overview

This skill provides guidance for developers working on the PowerPlatform Dataverse Client Python SDK repository itself (not using the SDK).

Best Practices

API Design

  1. Public methods in operation namespaces - New public methods go in the appropriate namespace module under src/PowerPlatform/Dataverse/operations/ (records.py, query.py, tables.py). The client.py file exposes these via namespace properties (client.records, client.query, client.tables). Public types and constants live in their own modules (e.g., models/table_info.py, common/constants.py)
  2. Every public method needs README example - Public API methods must have examples in README.md
  3. Reuse existing APIs - Always check if an existing method can be used before making direct Web API calls
  4. Update documentation when adding features - Keep README and SKILL files (both copies) in sync
  5. Consider backwards compatibility - Avoid breaking changes
  6. Internal vs public naming - Modules, files, and functions not meant to be part of the public API must use a _ prefix (e.g., _odata.py, _relationships.py). Files without the prefix (e.g., constants.py, metadata.py) are public and importable by SDK consumers

Code Style

  1. No emojis - Do not use emoji in code, comments, or output
  2. Standardize output format - Use [INFO], [WARN], [ERR], [OK] prefixes for console output
  3. No noqa comments - Do not add # noqa: BLE001 or similar linter suppression comments
  4. Document public APIs - Add Sphinx-style docstrings with examples for public methods
  5. Define all in module files - Each module declares its own exports via __all__ (e.g., errors.py defines __all__ = ["HttpError", ...]). Package __init__.py files should not re-export or redefine another module's __all__; they use __all__ = [] to indicate no star-import exports.
  6. Run black before committing - Always run python -m black <changed files> before committing. CI will reject unformatted code. Config is in pyproject.toml under [tool.black].