updating README

This commit is contained in:
evilchili
2024-03-26 00:46:59 -07:00
parent eb1b557ecf
commit b0cd78e608
+17 -11
View File
@@ -82,24 +82,30 @@ You can also run individual steps; see `slam --help` for details:
Usage: slam [OPTIONS] COMMAND [ARGS]... Usage: slam [OPTIONS] COMMAND [ARGS]...
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────── ╭─ Options ──────────────────────────────────────────────────────────────────────╮
│ --verbose --no-verbose Enable verbose output. [default: no-verbose] │ --verbose --no-verbose Enable verbose output.
--log-level TEXT Set the log level. [default: error] [default: no-verbose]
│ --poetry PATH Path to the poetry executable; defaults to the first │ --log-level TEXT Set the log level.
in your path. [default: error]
│ --poetry PATH Path to the poetry executable;
│ defaults to the first in your │
│ path. │
[default: poetry] [default: poetry]
│ --install-completion Install completion for the current shell. │ --install-completion Install completion for the │
--show-completion Show completion for the current shell, to copy it or current shell.
customize the installation. --show-completion Show completion for the current
│ shell, to copy it or customize │
│ the installation. │
│ --help Show this message and exit. │ │ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────── ╰────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────── ╭─ Commands ─────────────────────────────────────────────────────────────────────╮
│ build Calls format, test, and install before invoking 'poetry build'. │ │ build Calls format, test, and install before invoking 'poetry build'. │
│ format Run isort, autoflake, and black on the src/ and test/ directories. │ │ format Run isort, autoflake, and black on the src/ and test/ directories. │
│ init Add opinionated defaults to your pyproject.toml. │ │ init Add opinionated defaults to your pyproject.toml. │
│ install Synonym for 'poetry install' │ install Synonym for 'poetry install'
test Synonym for 'poetry run pytest' Output is always verbose. │ test Synonym for 'poetry run pytest' Output is always verbose. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────── ╰────────────────────────────────────────────────────────────────────────────────╯
``` ```
### Testing With Pytest ### Testing With Pytest