From 0c5c4bdbd6e03ec4e6cd970cde387306c791cb54 Mon Sep 17 00:00:00 2001 From: Nathan McDougall Date: Wed, 18 Jun 2025 22:22:41 +1200 Subject: [PATCH 1/6] Add README draft --- README.md | 64 +++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 43 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 143da5e0..f7a77cb6 100644 --- a/README.md +++ b/README.md @@ -85,6 +85,7 @@ $ pipx run usethis tool ruff - [`usethis author`](#usethis-author) — Set new author information for the project. - [`usethis docstyle`](#usethis-docstyle-style) — Set new author information for the project. - [`usethis rule`](#usethis-rule-rulecode) — Set a docstring style convention for the project, and [enforce it with Ruff](https://docs.astral.sh/ruff/rules/#pydocstyle-d). +- [`usethis status`](#usethis-status-status) — Set the development status of the project (via trove classifiers). ### Manage README @@ -349,23 +350,27 @@ Supported options: - `--offline` to disable network access and rely on caches - `--quiet` to suppress output -### `usethis rule ` +### `usethis readme` -Add (or manage configuration) of Ruff and Deptry rules in `pyproject.toml`. +Add a README.md file to the project. -See [the Ruff documentation](https://docs.astral.sh/ruff/rules/) for a list of available -rules, and [the Deptry documentation](https://deptry.com/rules-violations/) for a list -of available rules. +Supported options: -Example: +- `--quiet` to suppress output +- `--badges` to also add badges to the README.md file -`usethis rule RUF001` +### `usethis author` -Supported options: +Set new author information for the project. -- `--remove` to remove the rule selection or ignore status. -- `--ignore` to add the rule to the ignore list (or remove it if --remove is specified). -- `--offline` to disable network access and rely on caches +Required options: + +- `--name` for the new author's name + +Other supported options: + +- `--email` to set the author email address +- `--overwrite` to overwrite all existing author information - `--quiet` to suppress output ### `usethis docstyle