Skip to content

build: update pre-commit hooks #238

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
pre-commit-ci wants to merge 2 commits into from
Closed

build: update pre-commit hooks #238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0056347
build: update pre-commit hooks
pre-commit-ci[bot] Jan 7, 2025
4ff72bc
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ repos:
- id: pyproject-fmt

- repo: https://github.com/executablebooks/mdformat
rev: 00812cd1850e41aae5c0916645b4b7404f538e8c # frozen: 0.7.19
rev: e20b1ac5acb8aba0b49d3a9109c6e6b58684ee83 # frozen: 0.7.21
hooks:
- id: mdformat
args: [--number, --wrap=120, --ignore-missing-references]
Expand All @@ -80,14 +80,14 @@ repos:
- ruff==0.6.1

- repo: https://github.com/astral-sh/ruff-pre-commit
rev: 8b76f04e7e5a9cd259e9d1db7799599355f97cdf # frozen: v0.8.2
rev: 89c421dff2e1026ba12cdb9ebd731f4a83aa8021 # frozen: v0.8.6
hooks:
- id: ruff
args: [--fix, --show-fixes, --exit-non-zero-on-fix]
- id: ruff-format

- repo: https://github.com/pre-commit/mirrors-mypy
rev: f56614daa94d5cd733d3b7004c5df9caad267b4a # frozen: v1.13.0
rev: bbc3dc1f890007061f18f17e2334f216ea9e5df7 # frozen: v1.14.1
hooks:
- id: mypy
args: [--config-file=pyproject.toml]
Expand All @@ -106,7 +106,7 @@ repos:
- id: sp-repo-review

- repo: https://github.com/crate-ci/typos
rev: 1ea1ce4bc91a240102189742ddac7480304b52b1 # frozen: typos-dict-v0.11.37
rev: b1b019a4372e6055cd23b7a8e299c56f9d522a94 # frozen: dictgen-v0.3.1
hooks:
- id: typos
args: [--force-exclude]
Expand All @@ -118,7 +118,7 @@ repos:
- id: licensecheck

- repo: https://github.com/compilerla/conventional-pre-commit
rev: 48af87c8983cb0f5ba7693448da007b731196715 # frozen: v3.6.0
rev: 4394e2e7ab54549ad3f61cd32ae044710f885d12 # frozen: v4.0.0
hooks:
- id: conventional-pre-commit
stages: [commit-msg]
Expand Down
4 changes: 4 additions & 0 deletions docs/src/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ python -m pip install python-re3data
This will automatically install compatible versions of all dependencies, including `httpx` and `xsdata`.

!!! note

It is highly recommended creating a virtual environment before installing the project. This will help keep your
dependencies isolated and prevent conflicts with other projects. You can use `venv` to create and manage virtual
environments.
Expand All @@ -29,6 +30,7 @@ For more details, see [Optional Dependencies](#optional-dependencies).
- Python 3.10 or higher installed on your machine

!!! tip "Alternative: Use uv instead of pip"

[uv](https://github.com/astral-sh/uv)[^1] is a fast Python package installer and resolver, written in Rust.

Create a virtual environment in the current directory:
Expand All @@ -52,6 +54,7 @@ docker pull ghcr.io/afuetterer/python-re3data:latest
```

!!! note

The optional `[cli]` dependency group is pre-installed in the Docker image and the `re3data` executable is provided as
an entry point.

Expand All @@ -63,6 +66,7 @@ $ docker run --rm afuetterer/python-re3data --version
```

!!! tip "Alternative: Use Podman instead of Docker"

[Podman](https://podman.io/) is an open-source containerization platform that allows you to create, run, and manage
Linux containers.

Expand Down
Loading