microsoft / microsoft/semantic-kernel
Document Python connector extras and optional dependency compatibility
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 28.6k
- Forks
- 4.8k
- Avg merge
- 14h 13m
- Merged PRs (30d)
- 18
Description
Summary
Add a single Python contributor/user reference mapping Semantic Kernel connectors to their install extras and important optional dependency constraints.
Current implementation facts
Semantic Kernel's Python package supports multiple connectors with optional third-party SDKs. Import-time failures can otherwise surface far from installation.
Problem
Users and contributors must inspect pyproject metadata and individual connector docs to determine which extra installs a connector and which upstream versions are supported.
Scope
- Add a generated or maintained compatibility table.
- Include connector name, import path, install extra, and upstream package.
- Link to connector-specific configuration docs.
- State how version constraints are validated in CI.
Non-goals
- Do not broaden dependency version ranges.
- Do not combine all connectors into the default install.
Acceptance criteria
- Every public Python connector maps to an extra or explicitly states none.
- Table entries can be checked against package metadata.
- Documentation builds successfully.
I searched Semantic Kernel issues and PRs for Python connector extras, optional dependencies, compatibility matrix, and install guidance before filing this proposal.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the Python package metadata in pyproject and the existing connector-specific documentation to enumerate public connectors, import paths, extras, and upstream packages. Then inspect CI's version-constraint validation and the documentation build. Done means every connector is mapped or marked as having no extra, entries match metadata, configuration docs are linked, and the docs build succeeds.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100