Skip to content

Commit

Permalink
Add a list of the existing interfaces to the readme. (#68)
Browse files Browse the repository at this point in the history
  • Loading branch information
nathanjmcdougall authored Oct 29, 2024
1 parent 12f3db3 commit cee6f17
Showing 1 changed file with 51 additions and 0 deletions.
51 changes: 51 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,57 @@

Automate Python package and project setup tasks that are otherwise performed manually.

## Commands

### `usethis tool`

Add a new tool to a Python project, including:

- declared & installed dependencies with `uv add`,
- relevant `pyproject.toml` configuration,
- any other relevant directories or tool-bespoke configuration files, and
- `.pre-commit-config.yaml` configuration if using `pre-commit`.

Currently supported tools:

- ruff
- pytest
- deptry
- pre-commit

Example:

`usethis tool ruff`

Supported arguments:

- `--remove` to remove the tool instead of adding it
- `--offline` to disable network access and rely on caches

### `usethis ci`

Add Continuous Integration pipelines to the project.

Currently supported platforms:

- Bitbucket

Example:

`usethis ci bitbucket`.

### `usethis browse pypi`

Dispaly or open the PyPI landing page associated with another project.

Example:

`usethis browse pypi numpy`

Supported arguments:

- `--browser` to open the link in the browser automatically.

## Development

[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
Expand Down

0 comments on commit cee6f17

Please sign in to comment.