pyproject-pre-commit 0.3.6__py3-none-any.whl → 0.4.1__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,13 +1,14 @@
1
- Metadata-Version: 2.3
1
+ Metadata-Version: 2.4
2
2
  Name: pyproject-pre-commit
3
- Version: 0.3.6
3
+ Version: 0.4.1
4
4
  Summary: pre-commit hooks for python projects using pyproject.toml.
5
5
  Project-URL: Repository, https://github.com/rcmdnk/pyproject-pre-commit
6
6
  Project-URL: Documentation, https://github.com/rcmdnk/pyproject-pre-commit
7
7
  Project-URL: Homepage, https://github.com/rcmdnk/pyproject-pre-commit
8
8
  Project-URL: Issue, https://github.com/rcmdnk/pyproject-pre-commit/issues
9
9
  Author-email: rcmdnk <rcmdnk@gmail.com>
10
- License: Apache-2.0
10
+ License-Expression: Apache-2.0
11
+ License-File: LICENSE
11
12
  Keywords: pre-commit,pyproject.toml,uv
12
13
  Classifier: Development Status :: 3 - Alpha
13
14
  Classifier: Environment :: Console
@@ -17,24 +18,7 @@ Classifier: Topic :: Software Development
17
18
  Classifier: Topic :: Software Development :: Libraries :: Python Modules
18
19
  Classifier: Topic :: Utilities
19
20
  Requires-Python: >=3.9.0
20
- Requires-Dist: autoflake>=2.2.1
21
- Requires-Dist: autopep8>=2.0.4
22
- Requires-Dist: bandit[toml]>=1.7.5
23
- Requires-Dist: black>=24.3.0
24
- Requires-Dist: blacken-docs>=1.16.0
25
- Requires-Dist: flake8-annotations-complexity>=0.0.8
26
- Requires-Dist: flake8-bugbear>=24.0.0
27
- Requires-Dist: flake8-builtins>=2.1.0
28
- Requires-Dist: flake8-comprehensions>=3.14.0
29
- Requires-Dist: flake8-debugger>=4.1.2
30
- Requires-Dist: flake8-docstrings>=1.7.0
31
- Requires-Dist: flake8-executable>=2.1.3
32
- Requires-Dist: flake8-pep3101>=2.0.0
33
- Requires-Dist: flake8-print>=5.0.0
34
- Requires-Dist: flake8-pyproject>=1.2.3
35
- Requires-Dist: flake8-rst-docstrings>=0.3.0
36
- Requires-Dist: flake8-string-format>=0.3.0
37
- Requires-Dist: isort>=5.12.0
21
+ Requires-Dist: actionlint-py>=1.7.7.23
38
22
  Requires-Dist: mdformat-config>=0.2.1
39
23
  Requires-Dist: mdformat-footnote>=0.1.1
40
24
  Requires-Dist: mdformat-frontmatter>=2.0.1
@@ -47,11 +31,53 @@ Requires-Dist: mdformat-web>=0.2.0
47
31
  Requires-Dist: mdformat>=0.7.17
48
32
  Requires-Dist: mypy>=1.5.1
49
33
  Requires-Dist: numpydoc>=1.8.0
50
- Requires-Dist: pep8-naming>=0.14.0
51
34
  Requires-Dist: pre-commit>=4.0.0
52
- Requires-Dist: pycodestyle>=2.11.0
53
35
  Requires-Dist: shellcheck-py>=0.9.0.5
54
36
  Requires-Dist: validate-pyproject[all]>=0.22
37
+ Provides-Extra: all
38
+ Requires-Dist: autoflake>=2.2.1; extra == 'all'
39
+ Requires-Dist: autopep8>=2.0.4; extra == 'all'
40
+ Requires-Dist: bandit[toml]>=1.7.5; extra == 'all'
41
+ Requires-Dist: black>=24.3.0; extra == 'all'
42
+ Requires-Dist: blacken-docs>=1.16.0; extra == 'all'
43
+ Requires-Dist: flake8-annotations-complexity>=0.0.8; extra == 'all'
44
+ Requires-Dist: flake8-bugbear>=24.0.0; extra == 'all'
45
+ Requires-Dist: flake8-builtins>=2.1.0; extra == 'all'
46
+ Requires-Dist: flake8-comprehensions>=3.14.0; extra == 'all'
47
+ Requires-Dist: flake8-debugger>=4.1.2; extra == 'all'
48
+ Requires-Dist: flake8-docstrings>=1.7.0; extra == 'all'
49
+ Requires-Dist: flake8-executable>=2.1.3; extra == 'all'
50
+ Requires-Dist: flake8-pep3101>=2.0.0; extra == 'all'
51
+ Requires-Dist: flake8-print>=5.0.0; extra == 'all'
52
+ Requires-Dist: flake8-pyproject>=1.2.3; extra == 'all'
53
+ Requires-Dist: flake8-rst-docstrings>=0.3.0; extra == 'all'
54
+ Requires-Dist: flake8-string-format>=0.3.0; extra == 'all'
55
+ Requires-Dist: isort>=5.12.0; extra == 'all'
56
+ Requires-Dist: mdformat-ruff>=0.1.3; extra == 'all'
57
+ Requires-Dist: pep8-naming>=0.14.0; extra == 'all'
58
+ Requires-Dist: pycodestyle>=2.11.0; extra == 'all'
59
+ Requires-Dist: ruff>=0.7.2; extra == 'all'
60
+ Provides-Extra: black
61
+ Requires-Dist: autoflake>=2.2.1; extra == 'black'
62
+ Requires-Dist: autopep8>=2.0.4; extra == 'black'
63
+ Requires-Dist: bandit[toml]>=1.7.5; extra == 'black'
64
+ Requires-Dist: black>=24.3.0; extra == 'black'
65
+ Requires-Dist: blacken-docs>=1.16.0; extra == 'black'
66
+ Requires-Dist: flake8-annotations-complexity>=0.0.8; extra == 'black'
67
+ Requires-Dist: flake8-bugbear>=24.0.0; extra == 'black'
68
+ Requires-Dist: flake8-builtins>=2.1.0; extra == 'black'
69
+ Requires-Dist: flake8-comprehensions>=3.14.0; extra == 'black'
70
+ Requires-Dist: flake8-debugger>=4.1.2; extra == 'black'
71
+ Requires-Dist: flake8-docstrings>=1.7.0; extra == 'black'
72
+ Requires-Dist: flake8-executable>=2.1.3; extra == 'black'
73
+ Requires-Dist: flake8-pep3101>=2.0.0; extra == 'black'
74
+ Requires-Dist: flake8-print>=5.0.0; extra == 'black'
75
+ Requires-Dist: flake8-pyproject>=1.2.3; extra == 'black'
76
+ Requires-Dist: flake8-rst-docstrings>=0.3.0; extra == 'black'
77
+ Requires-Dist: flake8-string-format>=0.3.0; extra == 'black'
78
+ Requires-Dist: isort>=5.12.0; extra == 'black'
79
+ Requires-Dist: pep8-naming>=0.14.0; extra == 'black'
80
+ Requires-Dist: pycodestyle>=2.11.0; extra == 'black'
55
81
  Provides-Extra: ruff
56
82
  Requires-Dist: mdformat-ruff>=0.1.3; extra == 'ruff'
57
83
  Requires-Dist: ruff>=0.7.2; extra == 'ruff'
@@ -74,7 +100,6 @@ all necessary tools are installed as dependencies.
74
100
  - [Requirement](#requirement)
75
101
  - [Usage](#usage)
76
102
  - [Install pyproject-pre-commit](#install-pyproject-pre-commit)
77
- - [Install pyproject-pre-commit with ruff](#install-pyproject-pre-commit-with-ruff)
78
103
  - [Prepare .pre-commit-config.yaml](#prepare-pre-commit-configyaml)
79
104
  - [Run pre-commit](#run-pre-commit)
80
105
  - [Available ids](#available-ids)
@@ -86,7 +111,6 @@ all necessary tools are installed as dependencies.
86
111
  ## Requirement<a name="requirement"></a>
87
112
 
88
113
  - Python >= 3.9.0
89
- - Poetry (For development)
90
114
 
91
115
  ## Usage<a name="usage"></a>
92
116
 
@@ -95,32 +119,40 @@ all necessary tools are installed as dependencies.
95
119
  If your project uses poetry, do:
96
120
 
97
121
  ```
98
- $ poetry add --group dev pyproject-pre-commit
122
+ $ poetry add --group dev pyproject-pre-commit[ruff]
99
123
  ```
100
124
 
101
- Otherwise, install the package in your working environment.
102
-
103
- If you use pip, do:
125
+ or uv, do:
104
126
 
105
127
  ```
106
- $ pip install pyproject-pre-commit
128
+ $ poetry add --dev pyproject-pre-commit[ruff]
107
129
  ```
108
130
 
109
- This will install tools for pre-commit hooks in your working environment,
110
- so that you can use these tools, such as black, directly.
131
+ You can choose `ruff` or `black` as main linter/formatter by option.
111
132
 
112
- ### Install pyproject-pre-commit with ruff<a name="install-pyproject-pre-commit-with-ruff"></a>
133
+ If you want to use `black`, do:
134
+
135
+ ```
136
+ $ poetry add --dev pyproject-pre-commit[black]
137
+ ```
113
138
 
114
- If you want to use ruff, you can install pyproject-pre-commit with ruff option.
139
+ For `black` case, `autoflake`, `autopep8`, `isort`, `flake8` and `bandit` are also installed.
140
+
141
+ If you wish to install all, do:
115
142
 
116
143
  ```
117
- $ poetry add --group dev "pyproject-pre-commit[ruff]"
144
+ $ poetry add --dev pyproject-pre-commit[all]
118
145
  ```
119
146
 
147
+ If you use pip, do:
148
+
120
149
  ```
121
150
  $ pip install pyproject-pre-commit[ruff]
122
151
  ```
123
152
 
153
+ This will install tools for pre-commit hooks in your working environment,
154
+ so that you can use these tools, such as black, directly.
155
+
124
156
  ### Prepare .pre-commit-config.yaml<a name="prepare-pre-commit-configyaml"></a>
125
157
 
126
158
  Add **https://github.com/rcmdnk/pyproject-pre-commit** to your **.pre-commit-config.yaml**, like:
@@ -145,6 +177,8 @@ repos:
145
177
  - id: shellcheck
146
178
  - id: mdformat-check
147
179
  - id: mdformat
180
+ - id: actionlint
181
+ - id: validate-pyproject
148
182
  ```
149
183
 
150
184
  By using **pyproject-pre-commit**, you can simplify your **.pre-commit-config.yaml**
@@ -159,7 +193,7 @@ This can be made by `ppc` command:
159
193
  $ ppc --pre-commit > .pre-commit-config.yaml
160
194
  ```
161
195
 
162
- > \[!NOTE\]
196
+ > [!NOTE]
163
197
  > If you are using poetry, run `poetry run ppc ... ` or run after `poetry shell`.
164
198
 
165
199
  If you already have it, add hooks w/o `repos:` by
@@ -185,6 +219,8 @@ repos:
185
219
  - id: shellcheck
186
220
  - id: mdformat-check
187
221
  - id: mdformat
222
+ - id: actionlint
223
+ - id: validate-pyproject
188
224
  ```
189
225
 
190
226
  This can be made by `ppc` command:
@@ -211,7 +247,7 @@ then you can run pre-commit by:
211
247
  $ pre-commit run --all-files
212
248
  ```
213
249
 
214
- > \[!NOTE\]
250
+ > [!NOTE]
215
251
  > If you are using poetry, run `poetry run pre-commit ... ` or run after `poetry shell`.
216
252
 
217
253
  ## Available ids<a name="available-ids"></a>
@@ -261,6 +297,10 @@ There are ids for following tools:
261
297
  - [mdformat-gfm](https://github.com/hukkin/mdformat-gfm)
262
298
  - [mdformat-frontmatter](https://github.com/butler54/mdformat-frontmatter)
263
299
  - [mdformat-footnote](https://github.com/executablebooks/mdformat-footnote)
300
+ - For GitHub Actions
301
+ - [actionlint](https://github.com/Mateusz-Grzelinski/actionlint-py): Lint GitHub workflows with actionlint.
302
+ - For pyproject.toml
303
+ - [validate-pyproject](https://github.com/abravalheri/validate-pyproject): Validate pyproject.toml file.
264
304
 
265
305
  All tools are installed as dependencies of **pyproject-pre-commit** package.
266
306
 
@@ -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=VJPy9QcGiTYtJXprg7KfwAmY2HLFYTBXjoftfzYVoiw,4395
5
- pyproject_pre_commit-0.3.6.dist-info/METADATA,sha256=kSsKPzDBWrGu3ZtxgqCyMguubZKN-Q7AXoW5bEHd750,10975
6
- pyproject_pre_commit-0.3.6.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
7
- pyproject_pre_commit-0.3.6.dist-info/entry_points.txt,sha256=SWEvPSMZ57o6ihwt-tVBkwQzvuq1Zk_Re4RJWtvM5Rw,50
8
- pyproject_pre_commit-0.3.6.dist-info/licenses/LICENSE,sha256=KPHimGp4ehdaHn7s0RrnWAqKefaRTu5b_zUz7cGVuo8,11337
9
- pyproject_pre_commit-0.3.6.dist-info/RECORD,,
5
+ pyproject_pre_commit-0.4.1.dist-info/METADATA,sha256=oR7JpFoo7w8dLYvE_ykiAh4Rr2xhrFOiMaOJrc-OAr8,12933
6
+ pyproject_pre_commit-0.4.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
7
+ pyproject_pre_commit-0.4.1.dist-info/entry_points.txt,sha256=SWEvPSMZ57o6ihwt-tVBkwQzvuq1Zk_Re4RJWtvM5Rw,50
8
+ pyproject_pre_commit-0.4.1.dist-info/licenses/LICENSE,sha256=KPHimGp4ehdaHn7s0RrnWAqKefaRTu5b_zUz7cGVuo8,11337
9
+ pyproject_pre_commit-0.4.1.dist-info/RECORD,,
@@ -1,4 +1,4 @@
1
1
  Wheel-Version: 1.0
2
- Generator: hatchling 1.26.3
2
+ Generator: hatchling 1.27.0
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any