Common python development utility scripts, wrapped in a library.

Go to file

grym 3b3c7a850a Update formatting for help text		2024-01-06 11:23:34 -05:00
dev_utils	Update formatting for help text	2024-01-06 11:23:34 -05:00
tests	First commit	2024-01-06 10:44:48 -05:00
.gitignore	First commit	2024-01-06 10:44:48 -05:00
.pre-commit-config.yaml	First commit	2024-01-06 10:44:48 -05:00
Makefile	Update formatting for help text	2024-01-06 11:23:34 -05:00
README.md	Update formatting for help text	2024-01-06 11:23:34 -05:00
pyproject.toml	First commit	2024-01-06 10:44:48 -05:00

README.md

dev-utils

This is a collection of utility scripts for handling common tasks on linux/mac machines.

Command line use

dev-utils


 Usage: dev-utils [OPTIONS] COMMAND [ARGS]...

 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                                                     │
╰──────────────────────────────────────────────────────────────────────────────╯

dev-utils precommit


 Usage: dev-utils precommit [OPTIONS]

 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.                      │
╰──────────────────────────────────────────────────────────────────────────────╯

dev-utils venv


 Usage: dev-utils venv [OPTIONS]

 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.         │
╰──────────────────────────────────────────────────────────────────────────────╯

dev-utils direnv-init


 Usage: dev-utils direnv-init [OPTIONS]

 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.            │
╰──────────────────────────────────────────────────────────────────────────────╯

dev-utils direnv


 Usage: dev-utils direnv [OPTIONS]

 Emit the contents of a .envrc file suitable for python development.

╭─ Options ────────────────────────────────────────────────────────────────────╮
│ --python-version        TEXT  [default: None]                                │
│ --help                        Show this message and exit.                    │
╰──────────────────────────────────────────────────────────────────────────────╯