Go to file

Calum Young 6299d2ca23 Update mirror.py to a uv script (#110 ) <!-- Thank you for contributing to Ruff! To help us out with reviewing, please consider the following: - Does this pull request include a summary of the change? (See below.) - Does this pull request include a descriptive title? - Does this pull request include references to any relevant issues? --> ## Summary From my reading of the [UV docs](https://docs.astral.sh/uv/guides/scripts/), `mirror.py` would be a good example of a standalone script. This PR updates `mirror.py` and the `main.yml` workflow to be a UV script and makes use of UV in the update process. ## Test Plan - Update the uv version (currently 0.8.4) to an older version e.g. 0.8.3 in both `pyproject.toml` and `README.md` - Run `uv run --no-project mirror.py` to check the update process still works as expected		2024-12-30 10:48:39 -05:00
.github	Update mirror.py to a uv script (#110 )	2024-12-30 10:48:39 -05:00
.gitignore	chore: update information (#76 )	2024-03-22 17:46:59 -05:00
.pre-commit-hooks.yaml	Check Jupyter notebooks by default, in sync with 0.6.0 (#96 )	2024-08-15 17:25:51 +01:00
LICENSE-APACHE	chore: update information (#76 )	2024-03-22 17:46:59 -05:00
LICENSE-MIT	chore: update information (#76 )	2024-03-22 17:46:59 -05:00
mirror.py	Update mirror.py to a uv script (#110 )	2024-12-30 10:48:39 -05:00
pyproject.toml	Update mirror.py to a uv script (#110 )	2024-12-30 10:48:39 -05:00
README.md	Mirror: 0.8.4	2024-12-19 13:41:32 +00:00

README.md

ruff-pre-commit

A pre-commit hook for Ruff.

Distributed as a standalone repository to enable installing Ruff via prebuilt wheels from PyPI.

Using Ruff with pre-commit

To run Ruff's linter and formatter (available as of Ruff v0.0.289) via pre-commit, add the following to your .pre-commit-config.yaml:

repos:
- repo: https://github.com/astral-sh/ruff-pre-commit
  # Ruff version.
  rev: v0.8.4
  hooks:
    # Run the linter.
    - id: ruff
    # Run the formatter.
    - id: ruff-format

To enable lint fixes, add the --fix argument to the lint hook:

repos:
- repo: https://github.com/astral-sh/ruff-pre-commit
  # Ruff version.
  rev: v0.8.4
  hooks:
    # Run the linter.
    - id: ruff
      args: [ --fix ]
    # Run the formatter.
    - id: ruff-format

To avoid running on Jupyter Notebooks, remove jupyter from the list of allowed filetypes:

repos:
- repo: https://github.com/astral-sh/ruff-pre-commit
  # Ruff version.
  rev: v0.8.4
  hooks:
    # Run the linter.
    - id: ruff
      types_or: [ python, pyi ]
      args: [ --fix ]
    # Run the formatter.
    - id: ruff-format
      types_or: [ python, pyi ]

When running with --fix, Ruff's lint hook should be placed before Ruff's formatter hook, and before Black, isort, and other formatting tools, as Ruff's fix behavior can output code changes that require reformatting.

When running without --fix, Ruff's formatter hook can be placed before or after Ruff's lint hook.

(As long as your Ruff configuration avoids any linter-formatter incompatibilities, ruff format should never introduce new lint errors, so it's safe to run Ruff's format hook after ruff check --fix.)

License

ruff-pre-commit is licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or https://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or https://opensource.org/licenses/MIT)

at your option.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in ruff-pre-commit by you, as defined in the Apache-2.0 license, shall be dually licensed as above, without any additional terms or conditions.