معرفی شرکت ها
cli-help-maker-0.2.0
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
CLI help message generator.
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | cli-help-maker-0.2.0 |
| نام | cli-help-maker |
| نسخه کتابخانه | 0.2.0 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | - |
| ایمیل نویسنده | Agustín Piqueres <agustin.piqueres@gmail.com> |
| آدرس صفحه اصلی | - |
| آدرس اینترنتی | https://pypi.org/project/cli-help-maker/ |
| مجوز | - |
# cli-help-maker
Command Line Interface help message generator.
[](https://github.com/psf/black)
[](https://github.com/plaguss/cli-help-maker/blob/main/LICENSE)
[](https://pypi.python.org/pypi/cli-help-maker)
<!-- [](https://codecov.io/gh/plaguss/cli-help-maker) -->
---
This repo contains a CLI to create simulated help messages with the positions annotated
of the commands, arguments and options. Its created as a separated package, but its intended use is to generate datasets to be used in [helpner-core](https://github.com/plaguss/helpner-core), which deals with the model that powers [helpner](https://github.com/plaguss/helpner).
## What range of help messages covers?
For the moment, it indents to recreate messages like those found in the examples of [docopt-ng](https://github.com/jazzband/docopt-ng).
This should cover CLI apps created in python using for example [argparse](https://docs.python.org/3/library/argparse.html), [click](https://click.palletsprojects.com/en/8.1.x/) or [typer](https://typer.tiangolo.com/)*.
*[typer](https://typer.tiangolo.com/) uses click underneath, but when `rich` its is installed, the message has a special (and prettier) layout, currently not in the scope.*
A proper list of items covered is yet to be made.
## Installation
It can be installed directly from PyPI:
`pip install cli-help-maker`
This creates the following CLI:
```console
❯ cli-help-maker --help
Usage: cli-help-maker [OPTIONS] INPUT_PATH [OUTPUT_PATH]
Function to generate a dataset of cli help messages from a .yaml file with the info.
A folder will be generated containing two jsonl files:
- arguments.jsonl: Contains the arguments that were generated, these can be associated to
each help message for further analysis.
- dataset.jsonl: A dataset of help messages with annotations.
╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────╮
│ * input_path FILE Path pointing to the .yaml file. [default: None] │
│ [required] │
│ output_path [OUTPUT_PATH] Dirname of the output path. If not given, creates a │
│ directory with the version number │
│ [default: None] │
╰──────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ────────────────────────────────────────────────────────────────────────────────────╮
│ --install-completion [bash|zsh|fish|powershell|pwsh] Install completion for the │
│ specified shell. │
│ [default: None] │
│ --show-completion [bash|zsh|fish|powershell|pwsh] Show completion for the │
│ specified shell, to copy it or │
│ customize the installation. │
│ [default: None] │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────────────────────╯
```
## Examples
The folder [examples](https://github.com/plaguss/cli-help-maker/tree/main/examples) contains a rough recreation of some of the examples found in `docopt-ng` repo, to see an example, run any of them, for example:
```bash
python examples/arguments_example_like.py
```
This would create a random help message with a layout similar to the one found in [docopt-ng](https://github.com/jazzband/docopt-ng/blob/master/examples/arguments_example.py) (approximately).
It highlights the labels using rich.
## Development
TBD
نیازمندی
| مقدار | نام |
|---|---|
| - | nltk>=3.8 |
| - | rich>=12.6.0 |
| - | ruamel.yaml>=0.17.21 |
| - | typer>=0.7.0 |
| - | srsly>=2.4.5 |
| - | pydantic>=1.10.2 |
| - | black |
| - | mypy |
| - | isort |
| - | pytest>=7.2.0 |
| - | pytest-cov>=4.0.0 |
| - | hypothesis>=6.61.0 |
| - | nox>=2022.11.21 |
نحوه نصب
نصب پکیج whl cli-help-maker-0.2.0:
pip install cli-help-maker-0.2.0.whl
نصب پکیج tar.gz cli-help-maker-0.2.0:
pip install cli-help-maker-0.2.0.tar.gz