search

click-contrib / click-man

Automate generation of man pages for python click applications :star:
MIT License
163 stars 35 forks source link

Add CLI tool. #16

Closed waylan closed 6 years ago

waylan commented 6 years ago

A click application which takes a console_scripts entry point for an installed application and generates man pages. Addresses #15.

A few notes:

  1. This only works on installed packages which use console_scripts entry points and is useful for end users who have installed packages via pip (likely from a .whl file) and do not have access to a setup.py script.
  2. The pre-existing setuptools command can co-exist as it only works from a septup.py script which presumably has not been installed and is useful to OS level package maintainers and the like.
  3. The -V/--version option simply reports click-man's version and exits, unlike the pre-existing setuptools command which uses the --version option for the version of the "command" in the man pages.
  4. The version of the "command" for use in the man pages is determined from the "Distribution" of the entry point (entry_point.dist.version).
timofurrer commented 6 years ago

Awesome! Looks good. I'm happy merge this and thanks for the contribution! :tada:

waylan commented 6 years ago

Any idea when the next release will be? I see commit 8087a60 updated to version 0.2.2, but that version doesn't seem to have been pushed to PyPI.