Skip to content

Sync README with CLI help docs #587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 32 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,24 +55,28 @@ Alternatively, run in isolation, using `uvx` or `pipx`.

## 🖥️ Command Line Interface

### Main commands
### Manage Tooling

- [`usethis tool`](#usethis-tool)
- [`usethis ci`](#usethis-ci)
- [`usethis tool`](#usethis-tool)

### Configuration
### Manage Configuration

- [`usethis badge`](#usethis-badge)
- [`usethis rule`](#usethis-rule-rulecode)
- [`usethis author`](#usethis-author)
- [`usethis docstyle`](#usethis-docstyle)
- [`usethis rule`](#usethis-rule-rulecode)

### Manage README

- [`usethis badge`](#usethis-badge)
- [`usethis readme`](#usethis-readme)
- [`usethis author`](#usethis-author)

### Information

- [`usethis list`](#usethis-list)
- [`usethis show`](#usethis-show)
- [`usethis version`](#usethis-version)
- [`usethis browse pypi`](#usethis-browse-pypi-package)
- [`usethis show`](#usethis-show)

## 💡 Example Usage

Expand Down Expand Up @@ -126,18 +130,24 @@ Add a new tool to a Python project, including:
- any other relevant directories or tool-bespoke configuration files, and
- `.pre-commit-config.yaml` configuration if using `pre-commit`.

Currently supported tools:
#### Code Quality Tools

- `usethis tool codespell` - Use the codespell spellchecker: detect common spelling mistakes.
- `usethis tool deptry` - Use the deptry linter: avoid missing or superfluous dependency declarations.
- `usethis tool import-linter` - Use Import Linter: enforce a self-imposed architecture on imports.
- `usethis tool pre-commit` - Use the pre-commit framework to manage and maintain pre-commit hooks.
- `usethis tool pyproject-fmt` - Use the pyproject-fmt linter: opinionated formatting of 'pyproject.toml' files.
- `usethis tool ruff` - Use Ruff: an extremely fast Python linter and code formatter.

#### Testing

- `usethis tool codespell`
- `usethis tool coverage`
- `usethis tool deptry`
- `usethis tool import-linter`
- `usethis tool pre-commit`
- `usethis tool pyproject-fmt`
- `usethis tool pyproject.toml`
- `usethis tool pytest`
- `usethis tool requirements.txt`
- `usethis tool ruff`
- `usethis tool coverage` - Use coverage: a code coverage measurement tool.
- `usethis tool pytest` - Use the pytest testing framework.

#### Configuration Files

- `usethis tool pyproject.toml` - Use a pyproject.toml file to configure the project.
- `usethis tool requirements.txt` - Use a requirements.txt file exported from the uv lockfile.

Supported options:

Expand Down Expand Up @@ -234,6 +244,10 @@ Other supported options:

Display a table of all available tools and their current usage status.

### `usethis version`

Display the current version of usethis.

### `usethis show`

Show a piece of information about the project.
Expand Down
2 changes: 1 addition & 1 deletion src/usethis/_app.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
app.add_typer(usethis._interface.ci.app, name="ci", rich_help_panel=rich_help_panel)
app.add_typer(usethis._interface.tool.app, name="tool", rich_help_panel=rich_help_panel)

rich_help_panel = "Manage Config"
rich_help_panel = "Manage Configuration"
app.command(help="Add an author to the project.", rich_help_panel=rich_help_panel)(
usethis._interface.author.author,
)
Expand Down