Make `Klein` introspectable.
Open
Nobody has claimed this yet.
feature
- Dominant language
- Python
- Stars
- 838
- Forks
- 123
- Avg merge
- 7h 58m
- Merged PRs (30d)
- 12
Description
I'm working on generating some sphinx documentation from a klein application (loosely based on the autoflask directive from sphinxcontrib-httpdomain) but I need to access _url_map and _endpoints to get the relevant information.
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 Klein's _url_map and _endpoints attributes and the surrounding application introspection behavior. Define what route information a Sphinx documentation generator needs and make that information available through a stable public interface; done means the generator no longer needs to access those private attributes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend-api-design, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100