pyproject-pre-commit 0.3.4__py3-none-any.whl → 0.4.0__py3-none-any.whl

pyproject_pre_commit/pyproject_pre_commit.py

@@ -133,15 +133,27 @@ ignore-missing-imports = true
 scripts_are_modules = true
 install_types = true
 non_interactive = true
+
+[tool.numpydoc_validation]
+checks = [
+    "all",   # report on all checks, except the below
+    "EX01",  # "No examples section found"
+    "ES01",  # "No extended summary found"
+    "SA01",  # "See Also section not found"
+    "GL08",  # "The object does not have a docstring"
+    "PR01",  # "Parameters {missing_params} not documented"
+    "PR02",  # "Unknown parameters {unknown_params}"
+    "RT01",  # "No Returns section found"
+]
 """
     )
 
 
 def main() -> None:
     usage = "Usage: ppc <--pre-commit | --pyproject> [--ruff] [--black]"
-    if len(sys.argv) != 2:
+    if len(sys.argv) < 2:
         print(usage)  # noqa: T201
-        sys.exit(1)
+        sys.exit(0)
     is_ruff = "--ruff" in sys.argv
     if "--pre-commit" in sys.argv:
         pre_commit(is_ruff)

{pyproject_pre_commit-0.3.4.dist-info → pyproject_pre_commit-0.4.0.dist-info}/METADATA

@@ -1,11 +1,14 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: pyproject-pre-commit
-Version: 0.3.4
+Version: 0.4.0
 Summary: pre-commit hooks for python projects using pyproject.toml.
-Project-URL: repository, https://github.com/rcmdnk/pyproject-pre-commit
-Project-URL: homepage, https://github.com/rcmdnk/pyproject-pre-commit
-Project-URL: documentation, https://github.com/rcmdnk/pyproject-pre-commit
+Project-URL: Repository, https://github.com/rcmdnk/pyproject-pre-commit
+Project-URL: Documentation, https://github.com/rcmdnk/pyproject-pre-commit
+Project-URL: Homepage, https://github.com/rcmdnk/pyproject-pre-commit
+Project-URL: Issue, https://github.com/rcmdnk/pyproject-pre-commit/issues
 Author-email: rcmdnk <rcmdnk@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
 Keywords: pre-commit,pyproject.toml,uv
 Classifier: Development Status :: 3 - Alpha
 Classifier: Environment :: Console
@@ -15,24 +18,7 @@ Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Utilities
 Requires-Python: >=3.9.0
-Requires-Dist: autoflake>=2.2.1
-Requires-Dist: autopep8>=2.0.4
-Requires-Dist: bandit[toml]>=1.7.5
-Requires-Dist: black>=24.3.0
-Requires-Dist: blacken-docs>=1.16.0
-Requires-Dist: flake8-annotations-complexity>=0.0.8
-Requires-Dist: flake8-bugbear>=24.0.0
-Requires-Dist: flake8-builtins>=2.1.0
-Requires-Dist: flake8-comprehensions>=3.14.0
-Requires-Dist: flake8-debugger>=4.1.2
-Requires-Dist: flake8-docstrings>=1.7.0
-Requires-Dist: flake8-executable>=2.1.3
-Requires-Dist: flake8-pep3101>=2.0.0
-Requires-Dist: flake8-print>=5.0.0
-Requires-Dist: flake8-pyproject>=1.2.3
-Requires-Dist: flake8-rst-docstrings>=0.3.0
-Requires-Dist: flake8-string-format>=0.3.0
-Requires-Dist: isort>=5.12.0
+Requires-Dist: actionlint-py>=1.7.7.23
 Requires-Dist: mdformat-config>=0.2.1
 Requires-Dist: mdformat-footnote>=0.1.1
 Requires-Dist: mdformat-frontmatter>=2.0.1
@@ -45,11 +31,53 @@ Requires-Dist: mdformat-web>=0.2.0
 Requires-Dist: mdformat>=0.7.17
 Requires-Dist: mypy>=1.5.1
 Requires-Dist: numpydoc>=1.8.0
-Requires-Dist: pep8-naming>=0.14.0
 Requires-Dist: pre-commit>=4.0.0
-Requires-Dist: pycodestyle>=2.11.0
 Requires-Dist: shellcheck-py>=0.9.0.5
 Requires-Dist: validate-pyproject[all]>=0.22
+Provides-Extra: all
+Requires-Dist: autoflake>=2.2.1; extra == 'all'
+Requires-Dist: autopep8>=2.0.4; extra == 'all'
+Requires-Dist: bandit[toml]>=1.7.5; extra == 'all'
+Requires-Dist: black>=24.3.0; extra == 'all'
+Requires-Dist: blacken-docs>=1.16.0; extra == 'all'
+Requires-Dist: flake8-annotations-complexity>=0.0.8; extra == 'all'
+Requires-Dist: flake8-bugbear>=24.0.0; extra == 'all'
+Requires-Dist: flake8-builtins>=2.1.0; extra == 'all'
+Requires-Dist: flake8-comprehensions>=3.14.0; extra == 'all'
+Requires-Dist: flake8-debugger>=4.1.2; extra == 'all'
+Requires-Dist: flake8-docstrings>=1.7.0; extra == 'all'
+Requires-Dist: flake8-executable>=2.1.3; extra == 'all'
+Requires-Dist: flake8-pep3101>=2.0.0; extra == 'all'
+Requires-Dist: flake8-print>=5.0.0; extra == 'all'
+Requires-Dist: flake8-pyproject>=1.2.3; extra == 'all'
+Requires-Dist: flake8-rst-docstrings>=0.3.0; extra == 'all'
+Requires-Dist: flake8-string-format>=0.3.0; extra == 'all'
+Requires-Dist: isort>=5.12.0; extra == 'all'
+Requires-Dist: mdformat-ruff>=0.1.3; extra == 'all'
+Requires-Dist: pep8-naming>=0.14.0; extra == 'all'
+Requires-Dist: pycodestyle>=2.11.0; extra == 'all'
+Requires-Dist: ruff>=0.7.2; extra == 'all'
+Provides-Extra: black
+Requires-Dist: autoflake>=2.2.1; extra == 'black'
+Requires-Dist: autopep8>=2.0.4; extra == 'black'
+Requires-Dist: bandit[toml]>=1.7.5; extra == 'black'
+Requires-Dist: black>=24.3.0; extra == 'black'
+Requires-Dist: blacken-docs>=1.16.0; extra == 'black'
+Requires-Dist: flake8-annotations-complexity>=0.0.8; extra == 'black'
+Requires-Dist: flake8-bugbear>=24.0.0; extra == 'black'
+Requires-Dist: flake8-builtins>=2.1.0; extra == 'black'
+Requires-Dist: flake8-comprehensions>=3.14.0; extra == 'black'
+Requires-Dist: flake8-debugger>=4.1.2; extra == 'black'
+Requires-Dist: flake8-docstrings>=1.7.0; extra == 'black'
+Requires-Dist: flake8-executable>=2.1.3; extra == 'black'
+Requires-Dist: flake8-pep3101>=2.0.0; extra == 'black'
+Requires-Dist: flake8-print>=5.0.0; extra == 'black'
+Requires-Dist: flake8-pyproject>=1.2.3; extra == 'black'
+Requires-Dist: flake8-rst-docstrings>=0.3.0; extra == 'black'
+Requires-Dist: flake8-string-format>=0.3.0; extra == 'black'
+Requires-Dist: isort>=5.12.0; extra == 'black'
+Requires-Dist: pep8-naming>=0.14.0; extra == 'black'
+Requires-Dist: pycodestyle>=2.11.0; extra == 'black'
 Provides-Extra: ruff
 Requires-Dist: mdformat-ruff>=0.1.3; extra == 'ruff'
 Requires-Dist: ruff>=0.7.2; extra == 'ruff'
@@ -72,7 +100,6 @@ all necessary tools are installed as dependencies.
 - [Requirement](#requirement)
 - [Usage](#usage)
   - [Install pyproject-pre-commit](#install-pyproject-pre-commit)
-  - [Install pyproject-pre-commit with ruff](#install-pyproject-pre-commit-with-ruff)
   - [Prepare .pre-commit-config.yaml](#prepare-pre-commit-configyaml)
   - [Run pre-commit](#run-pre-commit)
 - [Available ids](#available-ids)
@@ -84,7 +111,6 @@ all necessary tools are installed as dependencies.
 ## Requirement<a name="requirement"></a>
 
 - Python >= 3.9.0
-- Poetry (For development)
 
 ## Usage<a name="usage"></a>
 
@@ -93,32 +119,40 @@ all necessary tools are installed as dependencies.
 If your project uses poetry, do:
 
 ```
-$ poetry add --group dev pyproject-pre-commit
+$ poetry add --group dev pyproject-pre-commit[ruff]
 ```
 
-Otherwise, install the package in your working environment.
-
-If you use pip, do:
+or uv, do:
 
 ```
-$ pip install pyproject-pre-commit
+$ poetry add --dev pyproject-pre-commit[ruff]
 ```
 
-This will install tools for pre-commit hooks in your working environment,
-so that you can use these tools, such as black, directly.
+You can choose `ruff` or `black` as main linter/formatter by option.
 
-### Install pyproject-pre-commit with ruff<a name="install-pyproject-pre-commit-with-ruff"></a>
+If you want to use `black`, do:
+
+```
+$ poetry add --dev pyproject-pre-commit[black]
+```
 
-If you want to use ruff, you can install pyproject-pre-commit with ruff option.
+For `black` case, `autoflake`, `autopep8`, `isort`, `flake8` and `bandit` are also installed.
+
+If you wish to install all, do:
 
 ```
-$ poetry add --group dev "pyproject-pre-commit[ruff]"
+$ poetry add --dev pyproject-pre-commit[all]
 ```
 
+If you use pip, do:
+
 ```
 $ pip install pyproject-pre-commit[ruff]
 ```
 
+This will install tools for pre-commit hooks in your working environment,
+so that you can use these tools, such as black, directly.
+
 ### Prepare .pre-commit-config.yaml<a name="prepare-pre-commit-configyaml"></a>
 
 Add **https://github.com/rcmdnk/pyproject-pre-commit** to your **.pre-commit-config.yaml**, like:
@@ -143,6 +177,8 @@ repos:
       - id: shellcheck
       - id: mdformat-check
       - id: mdformat
+      - id: actionlint
+      - id: validate-pyproject
 ```
 
 By using **pyproject-pre-commit**, you can simplify your **.pre-commit-config.yaml**
@@ -157,7 +193,7 @@ This can be made by `ppc` command:
 $ ppc --pre-commit > .pre-commit-config.yaml
 ```
 
-> \[!NOTE\]
+> [!NOTE]
 > If you are using poetry, run `poetry run ppc ... ` or run after `poetry shell`.
 
 If you already have it, add hooks w/o `repos:` by
@@ -183,6 +219,8 @@ repos:
       - id: shellcheck
       - id: mdformat-check
       - id: mdformat
+      - id: actionlint
+      - id: validate-pyproject
 ```
 
 This can be made by `ppc` command:
@@ -209,7 +247,7 @@ then you can run pre-commit by:
 $ pre-commit run --all-files
 ```
 
-> \[!NOTE\]
+> [!NOTE]
 > If you are using poetry, run `poetry run pre-commit ... ` or run after `poetry shell`.
 
 ## Available ids<a name="available-ids"></a>
@@ -259,6 +297,10 @@ There are ids for following tools:
       - [mdformat-gfm](https://github.com/hukkin/mdformat-gfm)
       - [mdformat-frontmatter](https://github.com/butler54/mdformat-frontmatter)
       - [mdformat-footnote](https://github.com/executablebooks/mdformat-footnote)
+- For GitHub Actions
+  - [actionlint](https://github.com/Mateusz-Grzelinski/actionlint-py): Lint GitHub workflows with actionlint.
+- For pyproject.toml
+  - [validate-pyproject](https://github.com/abravalheri/validate-pyproject): Validate pyproject.toml file.
 
 All tools are installed as dependencies of **pyproject-pre-commit** package.
 

pyproject_pre_commit-0.4.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+pyproject_pre_commit/__init__.py,sha256=rUeC_hXVqI0tVQ-QyGHvz0r9qkZHCG2D0Mql5Wu5udc,111
+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=VJPy9QcGiTYtJXprg7KfwAmY2HLFYTBXjoftfzYVoiw,4395
+pyproject_pre_commit-0.4.0.dist-info/METADATA,sha256=wt0OiUjxiLEmUny0O00h8qp3_FGCL8R9F8Or1ZzttdQ,12933
+pyproject_pre_commit-0.4.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pyproject_pre_commit-0.4.0.dist-info/entry_points.txt,sha256=SWEvPSMZ57o6ihwt-tVBkwQzvuq1Zk_Re4RJWtvM5Rw,50
+pyproject_pre_commit-0.4.0.dist-info/licenses/LICENSE,sha256=KPHimGp4ehdaHn7s0RrnWAqKefaRTu5b_zUz7cGVuo8,11337
+pyproject_pre_commit-0.4.0.dist-info/RECORD,,

{pyproject_pre_commit-0.3.4.dist-info → pyproject_pre_commit-0.4.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.26.1
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any

pyproject_pre_commit-0.3.4.dist-info/RECORD

@@ -1,9 +0,0 @@
-pyproject_pre_commit/__init__.py,sha256=rUeC_hXVqI0tVQ-QyGHvz0r9qkZHCG2D0Mql5Wu5udc,111
-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.4.dist-info/METADATA,sha256=NboKikhkBiGL9l_wwVA0WjzFPE1idAUI210I28KkYMw,10881
-pyproject_pre_commit-0.3.4.dist-info/WHEEL,sha256=3U_NnUcV_1B1kPkYaPzN-irRckL5VW_lytn0ytO_kRY,87
-pyproject_pre_commit-0.3.4.dist-info/entry_points.txt,sha256=SWEvPSMZ57o6ihwt-tVBkwQzvuq1Zk_Re4RJWtvM5Rw,50
-pyproject_pre_commit-0.3.4.dist-info/licenses/LICENSE,sha256=KPHimGp4ehdaHn7s0RrnWAqKefaRTu5b_zUz7cGVuo8,11337
-pyproject_pre_commit-0.3.4.dist-info/RECORD,,