evilchili/poetry-slam
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

typo

Browse Source
This commit is contained in:
evilchili 2024-03-26 00:45:45 -07:00
parent 4bf70ce2bc
commit eb1b557ecf
1 changed files with 27 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -61,7 +61,7 @@ You also don't need tool-specific configuration files or global defaults, since
The most common usage and the default if no command is specified is to do a `build`, which will:
* formats your source with isort, autoflake, and black;
* format your source with isort, autoflake, and black;
* run all tests;
* (re)install the packages in your projet virtual environment; and
* does a package release build
@ -75,7 +75,32 @@ Building...
slam build: SUCCESS
```
You can also run individual steps; see `slam --help` for details.
You can also run individual steps; see `slam --help` for details:
```bash
% slam --help
Usage: slam [OPTIONS] COMMAND [ARGS]...
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────╮
│ --verbose --no-verbose Enable verbose output. [default: no-verbose] │
│ --log-level TEXT Set the log level. [default: error] │
│ --poetry PATH Path to the poetry executable; defaults to the first │
│ in your path. │
│ [default: poetry] │
│ --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 ─────────────────────────────────────────────────────────────────────────────────────────╮
│ build Calls format, test, and install before invoking 'poetry build'. │
│ format Run isort, autoflake, and black on the src/ and test/ directories. │
│ init Add opinionated defaults to your pyproject.toml. │
│ install Synonym for 'poetry install' │
│ test Synonym for 'poetry run pytest' Output is always verbose. │
╰────────────────────────────────────────────────────────────────────────────────────────────────────╯
```
### Testing With Pytest