Skip to content

Commit

Permalink
update readme, remove black add ruff
Browse files Browse the repository at this point in the history
  • Loading branch information
NiklasRosenstein committed Jan 31, 2025
1 parent 00476fe commit 9db0713
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,16 +92,15 @@ If no arguments are supplied pytr will look for them in the file `~/.pytr/creden

## Linting and Code Formatting

This project uses [black](https://github.com/psf/black) for code linting and auto-formatting. You can auto-format the code by running:
This project uses [Ruff](https://astral.sh/ruff) for code linting and auto-formatting. You can auto-format the code by running:

```bash
# Install black if not already installed
pip install black

# Auto-format code
black ./pytr
uv run ruff format # Format code
uv run ruff check --fix-only # Remove unneeded imports, order imports, etc.
```

Ruff runs as part of CI and your Pull Request cannot be merged unless it satisfies the linting and formatting checks.

## Setting Up a Development Environment

1. Clone the repository:
Expand Down

0 comments on commit 9db0713

Please sign in to comment.