Update formatting for help text
This commit is contained in:
parent
8468e3b6c7
commit
3b3c7a850a
2
Makefile
2
Makefile
|
|
@ -24,5 +24,5 @@ test: install
|
|||
@$(VENV_BIN)/pytest --cov=dev_utils ./tests
|
||||
|
||||
docs: install
|
||||
@$(VENV_BIN)/cog -r ./README.md
|
||||
@TERMINAL_WIDTH=80 $(VENV_BIN)/cog -r ./README.md
|
||||
@$(VENV_BIN)/scriv collect
|
||||
|
|
|
|||
72
README.md
72
README.md
|
|
@ -20,20 +20,24 @@ cog.outl("```")
|
|||
|
||||
Usage: dev-utils [OPTIONS] COMMAND [ARGS]...
|
||||
|
||||
A collection of provisioning tools for common tasks during (mostly python) development.
|
||||
A collection of provisioning tools for common tasks during (mostly python)
|
||||
development.
|
||||
|
||||
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
||||
│ --version Show the version and exit. │
|
||||
│ --install-completion Install completion for the current shell. │
|
||||
│ --show-completion Show completion for the current shell, to copy it or customize the installation. │
|
||||
│ --help Show this message and exit. │
|
||||
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
||||
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
||||
│ direnv Emit the contents of a .envrc file suitable for python development. │
|
||||
│ direnv-init Configure the user's direnv rc file │
|
||||
│ precommit If precommit is available, run it until it succeeds or `max_tries` is exceeded. │
|
||||
│ venv Make a venv │
|
||||
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
||||
╭─ Options ────────────────────────────────────────────────────────────────────╮
|
||||
│ --version Show the version and exit. │
|
||||
│ --install-completion Install completion for the current shell. │
|
||||
│ --show-completion Show completion for the current shell, to copy │
|
||||
│ it or customize the installation. │
|
||||
│ --help Show this message and exit. │
|
||||
╰──────────────────────────────────────────────────────────────────────────────╯
|
||||
╭─ Commands ───────────────────────────────────────────────────────────────────╮
|
||||
│ direnv Emit the contents of a .envrc file suitable for python │
|
||||
│ development. │
|
||||
│ direnv-init Configure the user's direnv rc file │
|
||||
│ precommit If precommit is available, run it until it succeeds or │
|
||||
│ `max_tries` is exceeded. │
|
||||
│ venv Make a venv │
|
||||
╰──────────────────────────────────────────────────────────────────────────────╯
|
||||
|
||||
```
|
||||
<!-- [[[end]]] -->
|
||||
|
|
@ -54,12 +58,13 @@ for subname in _subcommand_names:
|
|||
|
||||
Usage: dev-utils precommit [OPTIONS]
|
||||
|
||||
If precommit is available, run it until it succeeds or `max_tries` is exceeded.
|
||||
If precommit is available, run it until it succeeds or `max_tries` is
|
||||
exceeded.
|
||||
|
||||
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
||||
│ --max-tries INTEGER [default: 3] │
|
||||
│ --help Show this message and exit. │
|
||||
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
||||
╭─ Options ────────────────────────────────────────────────────────────────────╮
|
||||
│ --max-tries INTEGER [default: 3] │
|
||||
│ --help Show this message and exit. │
|
||||
╰──────────────────────────────────────────────────────────────────────────────╯
|
||||
|
||||
```
|
||||
## dev-utils venv
|
||||
|
|
@ -69,12 +74,12 @@ for subname in _subcommand_names:
|
|||
|
||||
Make a venv
|
||||
|
||||
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
||||
│ --base-python TEXT [default: None] │
|
||||
│ --name TEXT [default: venv] │
|
||||
│ --do-update --no-do-update [default: do-update] │
|
||||
│ --help Show this message and exit. │
|
||||
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
||||
╭─ Options ────────────────────────────────────────────────────────────────────╮
|
||||
│ --base-python TEXT [default: None] │
|
||||
│ --name TEXT [default: venv] │
|
||||
│ --do-update --no-do-update [default: do-update] │
|
||||
│ --help Show this message and exit. │
|
||||
╰──────────────────────────────────────────────────────────────────────────────╯
|
||||
|
||||
```
|
||||
## dev-utils direnv-init
|
||||
|
|
@ -84,11 +89,12 @@ for subname in _subcommand_names:
|
|||
|
||||
Configure the user's direnv rc file
|
||||
|
||||
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
||||
│ --replace --no-replace [default: no-replace] │
|
||||
│ --target-dir PATH [default: /Users/gvoysey/.config/direnv] │
|
||||
│ --help Show this message and exit. │
|
||||
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
||||
╭─ Options ────────────────────────────────────────────────────────────────────╮
|
||||
│ --replace --no-replace [default: no-replace] │
|
||||
│ --target-dir PATH [default: │
|
||||
│ /Users/gvoysey/.config/direnv] │
|
||||
│ --help Show this message and exit. │
|
||||
╰──────────────────────────────────────────────────────────────────────────────╯
|
||||
|
||||
```
|
||||
## dev-utils direnv
|
||||
|
|
@ -98,10 +104,10 @@ for subname in _subcommand_names:
|
|||
|
||||
Emit the contents of a .envrc file suitable for python development.
|
||||
|
||||
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
||||
│ --python-version TEXT [default: None] │
|
||||
│ --help Show this message and exit. │
|
||||
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
||||
╭─ Options ────────────────────────────────────────────────────────────────────╮
|
||||
│ --python-version TEXT [default: None] │
|
||||
│ --help Show this message and exit. │
|
||||
╰──────────────────────────────────────────────────────────────────────────────╯
|
||||
|
||||
```
|
||||
<!-- [[[end]]] -->
|
||||
|
|
|
|||
|
|
@ -13,11 +13,7 @@ from dev_utils import __version__
|
|||
|
||||
IS_WINDOWS = sys.platform == "win32"
|
||||
|
||||
app = typer.Typer(
|
||||
context_settings={
|
||||
"max_content_width": 80,
|
||||
}
|
||||
)
|
||||
app = typer.Typer()
|
||||
|
||||
|
||||
def version_callback(value: bool):
|
||||
|
|
|
|||
Loading…
Reference in New Issue