Add API documentation on how to import and use this tool as a Python library
Open
Beginner friendly
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 12.5k
- Forks
- 998
- Avg merge
- 3d 13h
- Merged PRs (30d)
- 10
Description
I see lots of documentation on how to use this tool's CLI, but I'm curious if it has any support for being imported and used as a tool to build other tools and experiments on top of.
Requests:
- Update the README to explicitly say whether this project can be used as a library, or whether it's only a CLI
- If its use as a library is supported, add a link to library docs in the README
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 with the README and review the project’s existing public usage to determine whether it supports importing as a Python library. Update the README with an explicit statement about library support; if supported, add a link to the library documentation. Done means both requested points are addressed without changing the CLI guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100