Skip to main content

Generate man pages for click based CLI applications

Project description

# click-man

[![Build Status](https://travis-ci.org/timofurrer/click-man.svg?branch=master)](https://travis-ci.org/timofurrer/click-man) [![PyPI Package version](https://badge.fury.io/py/sure.svg)](https://pypi.python.org/pypi/click-man)

Create man pages for [click](https://github.com/pallets/click) application as easy as this:

`bash python3 setup.py --command-packages=click_man.commands man_pages `

![Demo](https://raw.githubusercontent.com/timofurrer/click-man/master/docs/asciicast.gif)

## What it does

click-man will generate one man page per command from your click CLI application specified in console_scripts in your setup.py.

## Installation

`bash pip3 install click-man `

click-man is also available for Python 2:

`bash pip install click-man `

## Usage Recipes

The following sections describe different usage example for click-man.

### Use with setuptools

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

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

or specify the man pages target directory:

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

### Debian packages

Coming soon …

### Standalone

Coming soon …

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

click-man-0.1.1.tar.gz (4.9 kB view hashes)

Uploaded source

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page