pyproject-pre-commit 0.3.0__py3-none-any.whl → 0.3.1__py3-none-any.whl

{pyproject_pre_commit-0.3.0.dist-info → pyproject_pre_commit-0.3.1.dist-info}/METADATA

@@ -1,11 +1,11 @@
 Metadata-Version: 2.3
 Name: pyproject-pre-commit
-Version: 0.3.0
+Version: 0.3.1
 Summary: pre-commit hooks for python projects using pyproject.toml.
 Author-email: rcmdnk <rcmdnk@gmail.com>
 License-Expression: Apache-2.0
 License-File: LICENSE
-Keywords: poetry,pre-commit,pyproject.toml
+Keywords: pre-commit,pyproject.toml,uv
 Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -84,6 +84,18 @@ $ pip install pyproject-pre-commit
 This will install tools for pre-commit hooks in your working environment,
 so that you can use these tools, such as black, directly.
 
+### Install pyproject-pre-commit with ruff
+
+If you want to use ruff, you can install pyproject-pre-commit with ruff option.
+
+```
+$ poetry add --group dev "pyproject-pre-commit[ruff]"
+```
+
+```
+$ pip install pyproject-pre-commit[ruff]
+```
+
 ### Prepare .pre-commit-config.yaml
 
 Add **https://github.com/rcmdnk/pyproject-pre-commit** to your **.pre-commit-config.yaml**, like:
@@ -133,6 +145,29 @@ $ ppc --pre-commit |grep -v "^repos:" >> .pre-commit-config.yaml
 
 You may want to modify after adding these configurations.
 
+To use `ruff` instead of such as `black`, `flake8`, `isort`, add following hooks:
+
+```yaml
+repos:
+- repo: https://github.com/rcmdnk/pyproject-pre-commit
+  rev: v0.3.0
+  hooks:
+  - id: ruff-lint-diff
+  - id: ruff-lint
+  - id: ruff-format-diff
+  - id: ruff-format
+  - id: mypy
+  - id: shellcheck
+  - id: mdformat-check
+  - id: mdformat
+```
+
+This can be made by `ppc` command:
+
+```
+$ ppc --pre-commit --ruff > .pre-commit-config.yaml
+```
+
 ### Run pre-commit
 
 `pre-commit` command is installed as dependencies of **pyproject-pre-commit** package.
@@ -161,14 +196,14 @@ You can find ids in **.pre-commit-hooks.yaml**.
 There are ids for following tools:
 
 - For Python
-  - black-diff: Just show Black result.
+  - [black-diff](https://black.readthedocs.io/en/stable): Just show Black result.
   - [black](https://black.readthedocs.io/en/stable): Black: The uncompromising Python code formatter.
   - [blacken-docs](https://github.com/adamchainz/blacken-docs): Run `black` on python code blocks in documentation files.
-  - autoflake-diff: Just show autoflake result.
+  - [autoflake-diff](https://github.com/PyCQA/autoflake): Just show autoflake result.
   - [autoflake](https://github.com/PyCQA/autoflake): autoflake removes unused imports and unused variables from Python code.
-  - autopep8-diff: Just show autopep8.
+  - [autopep8-diff](https://github.com/hhatto/autopep8): Just show autopep8.
   - [autopep8](https://github.com/hhatto/autopep8): autopep8 automatically formats Python code to conform to the PEP 8 style guide.
-  - isort-diff: Just show isort result.
+  - [isort-diff](https://github.com/PyCQA/isort): Just show isort result.
   - [isort](https://github.com/PyCQA/isort): isort your imports, so you don't have to.
   - [flake8](https://github.com/PyCQA/flake8): `flake8` is a command-line utility for enforcing style consistency across Python projects.
     - With following plugins:
@@ -188,6 +223,10 @@ There are ids for following tools:
       - [pycodestyle](https://pycodestyle.pycqa.org/en/latest/)
   - [bandit](https://github.com/PyCQA/bandit): Bandit is a tool for finding common security issues in Python code.
   - [mypy](https://www.mypy-lang.org/): Mypy is a static type checker for Python.
+  - [ruff-lint-diff](https://docs.astral.sh/ruff/): Just show ruff check result.
+  - [ruff-lint](https://docs.astral.sh/ruff/): Fix by ruff for lint.
+  - [ruff-format-diff](https://docs.astral.sh/ruff/): Just show ruff format result.
+  - [ruff-format](https://docs.astral.sh/ruff/): Format by ruff.
 - For Shell script
   - [shellcheck](https://www.shellcheck.net/): ShellCheck - A shell script static analysis tool
 - For Markdown
@@ -226,4 +265,10 @@ Example options can be made by `ppc` command:
 $ ppc --pyproject >> pyproject.toml
 ```
 
+or
+
+```
+$ ppc --pyproject --ruff >> pyproject.toml
+```
+
 You may want to modify after adding these configurations.

{pyproject_pre_commit-0.3.0.dist-info → pyproject_pre_commit-0.3.1.dist-info}/RECORD

@@ -2,7 +2,8 @@ pyproject_pre_commit/__init__.py,sha256=rUeC_hXVqI0tVQ-QyGHvz0r9qkZHCG2D0Mql5Wu5
 pyproject_pre_commit/__version__.py,sha256=IHT4mKrIr8eV-C3HtmIVD85iGVH25n2ohoff31kaJ1A,93
 pyproject_pre_commit/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pyproject_pre_commit/pyproject_pre_commit.py,sha256=AeMBDaJrcSyEVxB3g5V5d79ZvN_7zhyeEpr5mWP6Oyw,3962
-pyproject_pre_commit-0.3.0.dist-info/METADATA,sha256=qnV2Ca-wFn_7EAhfsKNRmPHRZQktAh3_mK5Ik7sxwIo,8258
-pyproject_pre_commit-0.3.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-pyproject_pre_commit-0.3.0.dist-info/licenses/LICENSE,sha256=KPHimGp4ehdaHn7s0RrnWAqKefaRTu5b_zUz7cGVuo8,11337
-pyproject_pre_commit-0.3.0.dist-info/RECORD,,
+pyproject_pre_commit-0.3.1.dist-info/METADATA,sha256=WoJYpjFcvTEw7hFyfh7duSaDS1AUocmNegvS-tKIrqg,9435
+pyproject_pre_commit-0.3.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+pyproject_pre_commit-0.3.1.dist-info/entry_points.txt,sha256=SWEvPSMZ57o6ihwt-tVBkwQzvuq1Zk_Re4RJWtvM5Rw,50
+pyproject_pre_commit-0.3.1.dist-info/licenses/LICENSE,sha256=KPHimGp4ehdaHn7s0RrnWAqKefaRTu5b_zUz7cGVuo8,11337
+pyproject_pre_commit-0.3.1.dist-info/RECORD,,

pyproject_pre_commit-0.3.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ppc = pyproject_pre_commit:main