Allow users to invoke pdoc CLI with `python -m pdoc`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
This is a question and/or enhancement request. I would like to invoke the pdoc CLI via something like
python -m pdoc --html MyCode
Is this possible?
I ask because after pip-installing on Windows, pdoc is on my path, but for some reason it's not registered with the OS as an executable. I get a prompt asking which program I'd like to use to open pdoc as if it was a media file. It would be nice usage to be able to invoke pdoc as written above.
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 pdoc's CLI entry point and packaging configuration. Check how the installed pdoc command is registered, then verify that python -m pdoc --html MyCode invokes the same behavior, including on Windows; done means the module form works without changing the existing CLI usage.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100