Skip to content

click-contrib/click-man

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

click-man

Under heavy development - feedback more than welcome!

It's never been easier to generate man pages for a python click CLI application:

pip install click_man
python setup.py --command-packages=click_man.commands man_pages

Demo

This will create a man folder with all the man pages generated for this click application.

How does it find my click application

click-man finds the click application because you've defined it in the entry_points map in your setup.py.

Installation

click-man is Python 2 and 3 compatible.

pip install click-man
pip3 install click-man

Invoke

click-man provides a sane setuptools command extension which can be used like the following:

python setup.py --command-packages=click_man.commands man_pages

or specify the man pages target directory:

python setup.py --command-packages=click_man.commands man_pages --target path/to/man/pages

About

Automate generation of man pages for python click applications ⭐

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages