Skip to main content

# 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 …

Metadata

Release files for click-man 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for click-man 0.1.1
File Size Uploaded
click-man-0.1.1.tar.gz 4.9 kB Details

Release files / click-man-0.1.1.tar.gz

Download URL click-man-0.1.1.tar.gz
Size 4.9 kB
Tags Source
SHA-256 checksum
How to use checksums
042d701319fb6f5768c162e98d87c30dae61bf8c434c1b4bbff26de53b9a05b0
BLAKE2b-256 checksum
How to use checksums
e8049b5736de0aa47a46907fec7d13a9c379d0c41aa2c61e555b67f1745efa43
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

0.5.1

2 release files

0.5.0

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.2

1 release file

0.2.1

1 release file

0.2.0

1 release file

This release

0.1.1 This release

1 release file

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page