cloudevents / cloudevents/sdk-python
Consider exposing public APIs
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 342
- Forks
- 65
- PR merge metrics
- No merged PRs in 30d
Description
We should consider exposing public APIs explicitly using __init__.py. This not only makes the usage easier but also allows evolving non-public APIs without breaking outside usage and providing better backward-compatibility.
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 locating the package init.py files and reviewing how the SDK currently exposes its APIs. Determine which interfaces should be public and how explicit exports would support backward compatibility. Done means the intended public APIs are clearly exposed without making non-public APIs part of the supported surface.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, backend
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100