Add more detailed API information to API section in README, provide mock keyring and backends implementation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.5k
- Forks
- 196
- PR merge metrics
- No merged PRs in 30d
Description
Currently, I am writing tests which need a mock keyring. Looking at this project, the README seems to be the primary or only documentation for using this module. I see a few areas which would improve my experience in using this module. These are expanding the API documentation to include type annotations and more detailed explanations and constraints for parameters, a reference to or provided mock for keyring using monkey patching, and a reference to or provided mock for a backend generator able to provide multiple mock backends.
This is with acknowledgement that [pytest-keyring](https://pypi.org/project/pytest-keyring/) appears insufficient for my needs.
Contributor guide
No contributing guide indexed for this repository
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 with the README, which is identified as the primary documentation for this module, and review the tests that need a mock keyring. Compare the requested API detail with pytest-keyring, then define what documentation, a monkey-patchable mock keyring, and a mock backend generator supporting multiple backends would need to provide.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend, documentation, testing
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100