From 0056347b45aaf55ba954b10e742f7536e5cdf846 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 7 Jan 2025 00:33:52 +0000 Subject: [PATCH 1/2] build: update pre-commit hooks MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit updates: - [github.com/executablebooks/mdformat: 00812cd1850e41aae5c0916645b4b7404f538e8c → e20b1ac5acb8aba0b49d3a9109c6e6b58684ee83](https://github.com/executablebooks/mdformat/compare/00812cd1850e41aae5c0916645b4b7404f538e8c...e20b1ac5acb8aba0b49d3a9109c6e6b58684ee83) - [github.com/astral-sh/ruff-pre-commit: 8b76f04e7e5a9cd259e9d1db7799599355f97cdf → 89c421dff2e1026ba12cdb9ebd731f4a83aa8021](https://github.com/astral-sh/ruff-pre-commit/compare/8b76f04e7e5a9cd259e9d1db7799599355f97cdf...89c421dff2e1026ba12cdb9ebd731f4a83aa8021) - [github.com/pre-commit/mirrors-mypy: f56614daa94d5cd733d3b7004c5df9caad267b4a → bbc3dc1f890007061f18f17e2334f216ea9e5df7](https://github.com/pre-commit/mirrors-mypy/compare/f56614daa94d5cd733d3b7004c5df9caad267b4a...bbc3dc1f890007061f18f17e2334f216ea9e5df7) - [github.com/crate-ci/typos: 1ea1ce4bc91a240102189742ddac7480304b52b1 → b1b019a4372e6055cd23b7a8e299c56f9d522a94](https://github.com/crate-ci/typos/compare/1ea1ce4bc91a240102189742ddac7480304b52b1...b1b019a4372e6055cd23b7a8e299c56f9d522a94) - [github.com/compilerla/conventional-pre-commit: 48af87c8983cb0f5ba7693448da007b731196715 → 4394e2e7ab54549ad3f61cd32ae044710f885d12](https://github.com/compilerla/conventional-pre-commit/compare/48af87c8983cb0f5ba7693448da007b731196715...4394e2e7ab54549ad3f61cd32ae044710f885d12) --- .pre-commit-config.yaml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index a8cebeb..498615f 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -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] @@ -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] @@ -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] @@ -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] From 4ff72bcd7f23463715fb42fb24d21300a9b445d0 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 7 Jan 2025 00:34:59 +0000 Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- docs/src/install.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/src/install.md b/docs/src/install.md index b0666b3..90b5ddf 100644 --- a/docs/src/install.md +++ b/docs/src/install.md @@ -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. @@ -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: @@ -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. @@ -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.