A tool for generating command documentation from Python CLI applications.
cmdpedia is a work-in-progress that aims to make documenting command line applications easier.
Given a Python (Click-only for now) module, it'll parse its docstring and commands to generate a single HTML file that displays this information in a searchable, interactive way.
View the cmdpedia for this project's main module.
Additional examples are located in the docs/example_modules folder.
Install the generator from PyPi by executing pip install cmdpedia_generator
Once installed, generate a cmdpedia by either importing the module and calling the generate() function with the program type and filepath passed as arguments, or by running the package as a script.
Usage examples can be found in the docs/example_modules folder.
Contributions are welcome! If you find a bug or have an idea for an enhancement, feel free to open an issue or submit a pull request.
If you have any questions about this project, please feel free to reach out to me at me@derekw.co.
FAQs
A tool for generating command documentation from Python CLI applications.
We found that cmdpedia-generator demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.
Security News
Research
The Socket Research Team uncovered a malicious Python package typosquatting the popular 'fabric' SSH library, silently exfiltrating AWS credentials from unsuspecting developers.
