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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,7 +1,10 @@
1
1
  Metadata-Version: 2.3
2
2
  Name: pyproject-pre-commit
3
- Version: 0.3.2
3
+ Version: 0.3.4
4
4
  Summary: pre-commit hooks for python projects using pyproject.toml.
5
+ Project-URL: repository, https://github.com/rcmdnk/pyproject-pre-commit
6
+ Project-URL: homepage, https://github.com/rcmdnk/pyproject-pre-commit
7
+ Project-URL: documentation, https://github.com/rcmdnk/pyproject-pre-commit
5
8
  Author-email: rcmdnk <rcmdnk@gmail.com>
6
9
  Keywords: pre-commit,pyproject.toml,uv
7
10
  Classifier: Development Status :: 3 - Alpha
@@ -30,9 +33,15 @@ Requires-Dist: flake8-pyproject>=1.2.3
30
33
  Requires-Dist: flake8-rst-docstrings>=0.3.0
31
34
  Requires-Dist: flake8-string-format>=0.3.0
32
35
  Requires-Dist: isort>=5.12.0
36
+ Requires-Dist: mdformat-config>=0.2.1
33
37
  Requires-Dist: mdformat-footnote>=0.1.1
34
38
  Requires-Dist: mdformat-frontmatter>=2.0.1
35
39
  Requires-Dist: mdformat-gfm>=0.3.5
40
+ Requires-Dist: mdformat-pyproject>=0.0.1
41
+ Requires-Dist: mdformat-rustfmt>=0.0.3
42
+ Requires-Dist: mdformat-tables>=1.0.0
43
+ Requires-Dist: mdformat-toc>=0.3.0
44
+ Requires-Dist: mdformat-web>=0.2.0
36
45
  Requires-Dist: mdformat>=0.7.17
37
46
  Requires-Dist: mypy>=1.5.1
38
47
  Requires-Dist: numpydoc>=1.8.0
@@ -40,11 +49,13 @@ Requires-Dist: pep8-naming>=0.14.0
40
49
  Requires-Dist: pre-commit>=4.0.0
41
50
  Requires-Dist: pycodestyle>=2.11.0
42
51
  Requires-Dist: shellcheck-py>=0.9.0.5
52
+ Requires-Dist: validate-pyproject[all]>=0.22
43
53
  Provides-Extra: ruff
54
+ Requires-Dist: mdformat-ruff>=0.1.3; extra == 'ruff'
44
55
  Requires-Dist: ruff>=0.7.2; extra == 'ruff'
45
56
  Description-Content-Type: text/markdown
46
57
 
47
- # pyproject-pre-commit
58
+ # pyproject-pre-commit<a name="pyproject-pre-commit"></a>
48
59
 
49
60
  [![test](https://github.com/rcmdnk/pyproject-pre-commit/actions/workflows/test.yml/badge.svg)](https://github.com/rcmdnk/pyproject-pre-commit/actions/workflows/test.yml)
50
61
  [![test coverage](https://img.shields.io/badge/coverage-check%20here-blue.svg)](https://github.com/rcmdnk/pyproject-pre-commit/tree/coverage)
@@ -56,14 +67,28 @@ Description-Content-Type: text/markdown
56
67
  By installing **pyproject-pre-commit** package,
57
68
  all necessary tools are installed as dependencies.
58
69
 
59
- ## Requirement
70
+ <!-- mdformat-toc start --slug=github --maxlevel=6 --minlevel=2 -->
71
+
72
+ - [Requirement](#requirement)
73
+ - [Usage](#usage)
74
+ - [Install pyproject-pre-commit](#install-pyproject-pre-commit)
75
+ - [Install pyproject-pre-commit with ruff](#install-pyproject-pre-commit-with-ruff)
76
+ - [Prepare .pre-commit-config.yaml](#prepare-pre-commit-configyaml)
77
+ - [Run pre-commit](#run-pre-commit)
78
+ - [Available ids](#available-ids)
79
+ - [Options for tools](#options-for-tools)
80
+ - [pyproject.toml](#pyprojecttoml)
81
+
82
+ <!-- mdformat-toc end -->
83
+
84
+ ## Requirement<a name="requirement"></a>
60
85
 
61
86
  - Python >= 3.9.0
62
87
  - Poetry (For development)
63
88
 
64
- ## Usage
89
+ ## Usage<a name="usage"></a>
65
90
 
66
- ### Install pyproject-pre-commit
91
+ ### Install pyproject-pre-commit<a name="install-pyproject-pre-commit"></a>
67
92
 
68
93
  If your project uses poetry, do:
69
94
 
@@ -82,7 +107,7 @@ $ pip install pyproject-pre-commit
82
107
  This will install tools for pre-commit hooks in your working environment,
83
108
  so that you can use these tools, such as black, directly.
84
109
 
85
- ### Install pyproject-pre-commit with ruff
110
+ ### Install pyproject-pre-commit with ruff<a name="install-pyproject-pre-commit-with-ruff"></a>
86
111
 
87
112
  If you want to use ruff, you can install pyproject-pre-commit with ruff option.
88
113
 
@@ -94,30 +119,30 @@ $ poetry add --group dev "pyproject-pre-commit[ruff]"
94
119
  $ pip install pyproject-pre-commit[ruff]
95
120
  ```
96
121
 
97
- ### Prepare .pre-commit-config.yaml
122
+ ### Prepare .pre-commit-config.yaml<a name="prepare-pre-commit-configyaml"></a>
98
123
 
99
124
  Add **https://github.com/rcmdnk/pyproject-pre-commit** to your **.pre-commit-config.yaml**, like:
100
125
 
101
126
  ```yaml
102
127
  repos:
103
- - repo: https://github.com/rcmdnk/pyproject-pre-commit
104
- rev: v0.3.0
105
- hooks:
106
- - id: black-diff
107
- - id: black
108
- - id: blacken-docs
109
- - id: autoflake-diff
110
- - id: autoflake
111
- - id: autopep8-diff
112
- - id: autopep8
113
- - id: isort-diff
114
- - id: isort
115
- - id: flake8
116
- - id: bandit
117
- - id: mypy
118
- - id: shellcheck
119
- - id: mdformat-check
120
- - id: mdformat
128
+ - repo: https://github.com/rcmdnk/pyproject-pre-commit
129
+ rev: v0.3.0
130
+ hooks:
131
+ - id: black-diff
132
+ - id: black
133
+ - id: blacken-docs
134
+ - id: autoflake-diff
135
+ - id: autoflake
136
+ - id: autopep8-diff
137
+ - id: autopep8
138
+ - id: isort-diff
139
+ - id: isort
140
+ - id: flake8
141
+ - id: bandit
142
+ - id: mypy
143
+ - id: shellcheck
144
+ - id: mdformat-check
145
+ - id: mdformat
121
146
  ```
122
147
 
123
148
  By using **pyproject-pre-commit**, you can simplify your **.pre-commit-config.yaml**
@@ -147,17 +172,17 @@ To use `ruff` instead of such as `black`, `flake8`, `isort`, add following hooks
147
172
 
148
173
  ```yaml
149
174
  repos:
150
- - repo: https://github.com/rcmdnk/pyproject-pre-commit
151
- rev: v0.3.0
152
- hooks:
153
- - id: ruff-lint-diff
154
- - id: ruff-lint
155
- - id: ruff-format-diff
156
- - id: ruff-format
157
- - id: mypy
158
- - id: shellcheck
159
- - id: mdformat-check
160
- - id: mdformat
175
+ - repo: https://github.com/rcmdnk/pyproject-pre-commit
176
+ rev: v0.3.0
177
+ hooks:
178
+ - id: ruff-lint-diff
179
+ - id: ruff-lint
180
+ - id: ruff-format-diff
181
+ - id: ruff-format
182
+ - id: mypy
183
+ - id: shellcheck
184
+ - id: mdformat-check
185
+ - id: mdformat
161
186
  ```
162
187
 
163
188
  This can be made by `ppc` command:
@@ -166,7 +191,7 @@ This can be made by `ppc` command:
166
191
  $ ppc --pre-commit --ruff > .pre-commit-config.yaml
167
192
  ```
168
193
 
169
- ### Run pre-commit
194
+ ### Run pre-commit<a name="run-pre-commit"></a>
170
195
 
171
196
  `pre-commit` command is installed as dependencies of **pyproject-pre-commit** package.
172
197
 
@@ -187,7 +212,7 @@ $ pre-commit run --all-files
187
212
  > \[!NOTE\]
188
213
  > If you are using poetry, run `poetry run pre-commit ... ` or run after `poetry shell`.
189
214
 
190
- ## Available ids
215
+ ## Available ids<a name="available-ids"></a>
191
216
 
192
217
  You can find ids in **.pre-commit-hooks.yaml**.
193
218
 
@@ -245,7 +270,7 @@ For tools which can format files, there are additional ids with `-diff` or `--ch
245
270
  which show the results before modifying files.
246
271
  You can see the differences after formatting if you place these ids before ids w/o `--diff` or `--check`.
247
272
 
248
- ## Options for tools
273
+ ## Options for tools<a name="options-for-tools"></a>
249
274
 
250
275
  You can set options in pyproject.toml for all tools above.
251
276
 
@@ -253,7 +278,7 @@ For flake8, flake8-pyproject allows to read options from pyproject.toml
253
278
 
254
279
  About bandit, there is a plugin for the flake8, but plugin version does not read options from pyproject.toml even with pyproject.toml. Therefore, use bandit directly and give `-c pyproject.toml` option in the hooks.
255
280
 
256
- ## pyproject.toml
281
+ ## pyproject.toml<a name="pyprojecttoml"></a>
257
282
 
258
283
  You can set options in pyproject.toml for all tools.
259
284
 
@@ -2,8 +2,8 @@ pyproject_pre_commit/__init__.py,sha256=rUeC_hXVqI0tVQ-QyGHvz0r9qkZHCG2D0Mql5Wu5
2
2
  pyproject_pre_commit/__version__.py,sha256=IHT4mKrIr8eV-C3HtmIVD85iGVH25n2ohoff31kaJ1A,93
3
3
  pyproject_pre_commit/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
4
4
  pyproject_pre_commit/pyproject_pre_commit.py,sha256=AeMBDaJrcSyEVxB3g5V5d79ZvN_7zhyeEpr5mWP6Oyw,3962
5
- pyproject_pre_commit-0.3.2.dist-info/METADATA,sha256=D8K6em_ZgS5r50oCLcYNDDs0P_vfiX2h7CoKQ0UYjtk,9382
6
- pyproject_pre_commit-0.3.2.dist-info/WHEEL,sha256=wukiCwsxxsuzcQTdnC_ZWHZECE4wwOh3xCCrap6i6Ts,87
7
- pyproject_pre_commit-0.3.2.dist-info/entry_points.txt,sha256=SWEvPSMZ57o6ihwt-tVBkwQzvuq1Zk_Re4RJWtvM5Rw,50
8
- pyproject_pre_commit-0.3.2.dist-info/licenses/LICENSE,sha256=KPHimGp4ehdaHn7s0RrnWAqKefaRTu5b_zUz7cGVuo8,11337
9
- pyproject_pre_commit-0.3.2.dist-info/RECORD,,
5
+ pyproject_pre_commit-0.3.4.dist-info/METADATA,sha256=NboKikhkBiGL9l_wwVA0WjzFPE1idAUI210I28KkYMw,10881
6
+ pyproject_pre_commit-0.3.4.dist-info/WHEEL,sha256=3U_NnUcV_1B1kPkYaPzN-irRckL5VW_lytn0ytO_kRY,87
7
+ pyproject_pre_commit-0.3.4.dist-info/entry_points.txt,sha256=SWEvPSMZ57o6ihwt-tVBkwQzvuq1Zk_Re4RJWtvM5Rw,50
8
+ pyproject_pre_commit-0.3.4.dist-info/licenses/LICENSE,sha256=KPHimGp4ehdaHn7s0RrnWAqKefaRTu5b_zUz7cGVuo8,11337
9
+ pyproject_pre_commit-0.3.4.dist-info/RECORD,,
@@ -1,4 +1,4 @@
1
1
  Wheel-Version: 1.0
2
- Generator: hatchling 1.26.0
2
+ Generator: hatchling 1.26.1
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any