Skip to content

Write Python SDK documentation (README, CHANGELOG, ROADMAP, GENERATION) #4

Description

@daviburg

Problem

Most documentation files were copied from the .NET SDK repo without adaptation to Python:

  • README.md — Stub placeholder ("Repository setup required") with no actual content
  • README copy.md — Full .NET SDK README that was apparently the copy source (should be deleted)
  • CHANGELOG.md — Documents .NET SDK releases (v0.1.0-preview.1, v0.2.0-preview.1) not Python
  • ROADMAP.md — ~1500 lines of .NET SDK roadmap content
  • GENERATION.md — Documents .NET code generation (C# output, NuGet integration) not Python
  • SUPPORT.md — References .NET SDK docs instead of Python

What needs to change

README.md — Write from scratch

Follow the .NET SDK README structure adapted for Python:

  1. Badges — CI status, PyPI version, Python versions, license
  2. Title & description — "Type-safe Python clients for Azure connectors"
  3. Why this SDK? — Async/await, type-safe, auth abstraction
  4. How it works — ASCII diagram: App → Generated Clients → SDK Core
  5. Installationpip install azure-connectors-sdk (once published)
  6. Quick start — Python code example showing Office365Client usage with async context manager
  7. Validated connectors table — Office365, SharePoint, Teams, Kusto, MS Graph (with status)
  8. Related repos — Links to .NET SDK, Samples, LSP
  9. Contributing & License

README copy.md — Delete

This is a verbatim copy of the .NET SDK README and serves no purpose.

CHANGELOG.md — Reset for Python

Start fresh with Python-specific entries:

  • v0.1.0dev1 — Initial Python SDK with core abstractions and Office365/SharePoint/Kusto/Teams/MsGraph clients

ROADMAP.md — Write Python-specific roadmap

Replace .NET content with Python milestones:

  • Current connector support status
  • PyPI publication timeline
  • Python samples project
  • Additional connector priorities

GENERATION.md — Document Python code generation

Replace .NET content with Python-specific generation:

  • LogicAppsCompiler CLI with --python flag (from BPM PR 15456622)
  • Generated output structure (azure/connectors/*.py files)
  • How generated clients extend ConnectorClientBase
  • Async patterns in generated code

SUPPORT.md — Update references

Replace .NET SDK doc references with Python SDK equivalents.

Reference

Acceptance criteria

  • README.md has badges, installation, quick start with Python code, validated connectors table
  • README copy.md deleted
  • CHANGELOG.md documents Python SDK versions only
  • ROADMAP.md is Python-specific
  • GENERATION.md documents Python code generation
  • SUPPORT.md references correct Python docs

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions