Skip to content

Document usethis show sonarqube more thoroughly #1562

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.

Sign up for GitHub

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
nathanjmcdougall merged 4 commits into from
Mar 26, 2026
Merged

Document usethis show sonarqube more thoroughly #1562

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e346068
Initial plan
Copilot Mar 26, 2026
1075c94
Initial plan for documenting usethis show sonarqube
Copilot Mar 26, 2026
1927521
docs: document usethis show sonarqube behavior more thoroughly
Copilot Mar 26, 2026
b1bcb68
Merge branch 'main' into copilot/document-usethis-show-sonarqube
nathanjmcdougall Mar 26, 2026
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
19 changes: 18 additions & 1 deletion docs/cli/reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,24 @@ Currently supported subcommands:

- `usethis show backend` to show the inferred project manager backend, e.g. 'uv' or 'none'. This is the default backend used, i.e. when `--backend=auto` is specified.
- `usethis show name` to show the name of the project.
- `usethis show sonarqube` to show appropriate contents of a `sonar-projects.properties` file for SonarQube analysis.
- `usethis show sonarqube` to show appropriate contents of a `sonar-project.properties` file for SonarQube analysis.

### `usethis show sonarqube`

Show the contents of a `sonar-project.properties` file for SonarQube analysis.

If a `sonar-project.properties` file already exists in the project root, its contents are returned as-is. In this case, the `--project-key` option and `tool.usethis.sonarqube.project-key` in `pyproject.toml` are both ignored.

If no `sonar-project.properties` file exists, the contents are constructed from `pyproject.toml` configuration. In this case, a project key is required:

- If `--project-key` is provided, it is used.
- Otherwise, `tool.usethis.sonarqube.project-key` from `pyproject.toml` is used.

Additional configuration in `pyproject.toml`:

- `tool.usethis.sonarqube.verbose` (bool, default `false`) — sets `sonar.verbose`.
- `tool.usethis.sonarqube.exclusions` (list of strings, default `[]`) — sets `sonar.exclusions`.
- `tool.coverage.xml.output` (string, required) — sets `sonar.python.coverage.reportPaths`.

## `usethis browse pypi <package>`

Expand Down