diff --git a/README.md b/README.md index 143da5e0..f02858a6 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 @@ -188,6 +189,15 @@ Supported options: - `numpy` for [NumPy docstring style](https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard) - `google` for [Google docstring style](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) - `pep257` for [PEP 257 docstring style](https://www.python.org/dev/peps/pep-0257/) +- `--status` to set the development status of the project. Defaults to `planning`. + Possible values: + - `planning` or `1` for "Development Status :: 1 - Planning" + - `pre-alpha` or `2` for "Development Status :: 2 - Pre-Alpha" + - `alpha` or `3` for "Development Status :: 3 - Alpha" + - `beta` or `4` for "Development Status :: 4 - Beta" + - `production` or `5` for "Development Status :: 5 - Production/Stable" + - `mature` or `6` for "Development Status :: 6 - Mature" + - `inactive` or `7` for "Development Status :: 7 - Inactive" - `--offline` to disable network access and rely on caches - `--quiet` to suppress output - `--frozen` to leave the virtual environment and lockfile unchanged (i.e. do not install dependencies, nor update lockfiles) @@ -349,23 +359,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