Science Score: 54.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 2 committers (50.0%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (6.3%) to scientific vocabulary
Keywords
Repository
Convert --help and --version to man page.
Basic Info
- Host: GitHub
- Owner: Freed-Wu
- License: gpl-3.0
- Language: Python
- Default Branch: main
- Homepage: https://help2man.readthedocs.io/
- Size: 80.1 KB
Statistics
- Stars: 5
- Watchers: 1
- Forks: 2
- Open Issues: 6
- Releases: 9
Topics
Metadata Files
README.md
help2man
Convert --help and --version to man page or other file types like markdown.
Usage
```sh $ help2man --help usage: help2man [-h] [-V] [--print-completion {bash,zsh,tcsh}] [-n NAME] [-s SECTION] [-m MANUAL] [-S SOURCE] [-p INFO_PAGE] [-i INCLUDE] [-o OUTPUT] [--template {man,markdown}] [--template-file TEMPLATE_FILE] [--help-option HELP_OPTION] [--version-option VERSION_OPTION] [--no-discard-stderr] executable ...
Convert --help and --version to man page.
positional arguments: executable executable program name ... executable program arguments
options: -h, --help show this help message and exit -V, --version show program's version number and exit
...
$ help2man --version help2man 0.0.9 Copyright (C) 2022-2023 Written by Wu Zhenyu. ```
Man
sh
help2man help2man | man --local-file -
```man HELP2MAN(1) User Commands HELP2MAN(1)
NAME help2man - Convert --help and --version to man page.
SYNOPSIS help2man [-h] [-V] [--print-completion {bash,zsh,tcsh}] [-n NAME] [-s SECTION] [-m MANUAL] [-S SOURCE] [-p INFO_PAGE] [-i INCLUDE] [-o OUTPUT] [--template {man,markdown}] [--template-file TEMPLATE_FILE] [--help-option HELP_OPTION] [--version-option VERSION_OPTION] [--no-discard-stderr] executable ...
DESCRIPTION Convert --help and --version to man page.
POSITIONAL ARGUMENTS executable executable program name
... executable program arguments
OPTIONS -h, --help show this help message and exit
-V, --version
show program's version number and exit
...
AUTHOR Written by Wu Zhenyu.
REPORTING BUGS Report bugs to https://github.com/Freed-Wu/help2man/issues .
COPYRIGHT Copyright © 2022-2023
help2man 0.0.9 2024-11-02 HELP2MAN(1) ```
Markdown
sh
help2man --template markdown help2man
```markdown
Man
Name
help2man - Convert ----help and ----version to man page.
Synopsis
help2man [-h] [-V] [----print-completion {bash,zsh,tcsh}] [-n NAME] [-s SECTION] [-m MANUAL] [-S SOURCE] [-p INFO_PAGE] [-i INCLUDE] [-o OUTPUT] [----template {man,markdown}] [----template-file TEMPLATE_FILE] [----help-option HELP_OPTION] [----version-option VERSION_OPTION] [----no-discard-stderr] executable ...
Description
Convert ----help and ----version to man page.
Positional arguments
executable
executable program name
...
executable program arguments
Options
-h, ----help
show this help message and exit
-V, ----version
show program's version number and exit
...
```
Similar Projects
- GNU help2man Generate manpage for
any program with
--helpand--version. Written in perl. - click-man Generate manpage for click-based python program. Written in python.
- cli2man Generate manpage and
markdown for any program with
--helpand--version. Written in python. - This project: Generate manpage, markdown or any format (if you provide
a jinja template) for
any program with
--helpand--versionor any argparse-based python program.
Intention
This a python version of GNU help2man. It solves the following problems[^email]:
GNU help2man cannot convert argparse correctly
Because argparse outputs:
```text usage: help2man [-h] ... executable ...
Convert --help and --version to man page.
positional arguments: executable executable program name ...
options: -h show this help message and exit ... ```
help2man will ignore positional arguments: and options: because it only
detect Options:. And it only detect first line as synopsis and detect other
lines as description incorrectly.
GNU help2man cannot customize template
I provide help2man --template XXX and help2man --template-file XXX to do
it. The template language is
jinja2. See
template
as examples.
GNU help2man don't provide any programming API
Now you can use it in python. If you want to generate man pages automatically when you build a python project, you can see setuptools-generate:
See document to know more.
[^email]: I send email to the author of GNU help2man but got no response.
Owner
- Name: wzy
- Login: Freed-Wu
- Kind: user
- Location: $HOME
- Company: @ustc-ivclab
- Website: https://freed-wu.github.io/
- Twitter: FreedWu
- Repositories: 267
- Profile: https://github.com/Freed-Wu
An adherent of hacker culture and open source.
Citation (CITATION.cff)
---
cff-version: 1.2.0
message: If you use this software, please cite it as below.
authors:
- family-names: Wu
given-names: Zhenyu
orcid: https://orcid.org/0000-0001-6478-9993
title: "help2man: Convert --help and --version to man page."
date-released: 2022-12-03
url: "https://github.com/Freed-Wu/help2man"
GitHub Events
Total
- Issues event: 2
- Watch event: 2
- Issue comment event: 3
- Push event: 59
- Pull request review event: 2
- Pull request review comment event: 1
- Pull request event: 2
- Fork event: 1
- Create event: 1
Last Year
- Issues event: 2
- Watch event: 2
- Issue comment event: 3
- Push event: 59
- Pull request review event: 2
- Pull request review comment event: 1
- Pull request event: 2
- Fork event: 1
- Create event: 1
Committers
Last synced: 8 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Wu Zhenyu | w****u@u****u | 28 |
| Alexandre ZANNI | 1****j | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 4
- Total pull requests: 5
- Average time to close issues: 4 minutes
- Average time to close pull requests: 12 months
- Total issue authors: 4
- Total pull request authors: 4
- Average comments per issue: 0.25
- Average comments per pull request: 0.8
- Merged pull requests: 1
- Bot issues: 0
- Bot pull requests: 2
Past Year
- Issues: 2
- Pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 2
- Pull request authors: 1
- Average comments per issue: 0.0
- Average comments per pull request: 0.5
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- doronbehar (1)
- vapier (1)
- noraj (1)
Pull Request Authors
- vapier (2)
- noraj (1)
- pre-commit-ci[bot] (1)
- renovate[bot] (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 1,345 last-month
- Total dependent packages: 1
- Total dependent repositories: 12
- Total versions: 7
- Total maintainers: 1
pypi.org: help2man
Convert --help and --version to man page.
- Homepage: https://help2man.readthedocs.io
- Documentation: https://help2man.readthedocs.io/
- License: GPL v3
-
Latest release: 0.0.9
published almost 3 years ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v3 composite
- actions/setup-python v4 composite
- actions/upload-artifact v3 composite
- codecov/codecov-action v3 composite
- pypa/gh-action-pypi-publish release/v1 composite
- softprops/action-gh-release v1 composite
- myst-parser *
- sphinxcontrib-eval *
- tomli *
- pre-commit * development
- pytest-cov * development
- shtab * development
- tomli * development
- jinja2 *
- actions/checkout v3 composite
- cachix/install-nix-action v22 composite