blob: 867fd9e468b338b7c23ab814ff6cc504f63c8b7e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
|
%global _empty_manifest_terminate_build 0
Name: python-pylint-gitlab
Version: 1.2.0
Release: 1
Summary: This project provides pylint formatters for a nice integration with GitLab CI.
License: MIT
URL: https://gitlab.com/smueller18/pylint-gitlab
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/78/a2/7a4dba9f516bc929caa038d87dfd4ea113a122244daa40eeed80e4ed3a2e/pylint-gitlab-1.2.0.tar.gz
BuildArch: noarch
Requires: python3-anybadge
Requires: python3-astroid
Requires: python3-dill
Requires: python3-importlib-metadata
Requires: python3-isort
Requires: python3-jinja2
Requires: python3-lazy-object-proxy
Requires: python3-markupsafe
Requires: python3-mccabe
Requires: python3-packaging
Requires: python3-platformdirs
Requires: python3-pylint
Requires: python3-pyparsing
Requires: python3-tomli
Requires: python3-tomlkit
Requires: python3-typing-extensions
Requires: python3-wrapt
Requires: python3-zipp
%description
# pylint-gitlab
[](https://gitlab.com/smueller18/pylint-gitlab/commits/master)
[](https://smueller18.gitlab.io/pylint-gitlab/coverage/)
[](https://smueller18.gitlab.io/pylint-gitlab/lint/)
[](https://pypi.org/project/pylint-gitlab/)
This project provides pylint formatters for a nice integration with GitLab CI.
| Formatter | Description |
| --- | --- |
| `GitlabCodeClimateReporter` | Maps the linting result in [Code Climate format](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html) |
| `GitlabCodeClimateReporterNoHash` | Maps the linting result in [Code Climate format](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html) but without hashing the fingerprint. Needed to work with [nbQA](https://github.com/nbQA-dev/nbQA). |
| `GitlabPagesHtmlReporter` | Creates a table in an HTML page with linting results and links to source code. |
## Usage
Install package `pylint-gitlab`:
```sh
pip install pylint-gitlab
```
The `pylint` package is a dependency of `pylint-gitlab` so it will be installed automatically.
Now the formatters can be used by running `pylint` command and setting custom output formats with parameter `--output-format`.
```sh
pylint --exit-zero --output-format=pylint_gitlab.GitlabCodeClimateReporter . > codeclimate.json
pylint --exit-zero --output-format=pylint_gitlab.GitlabPagesHtmlReporter . > pylint.html
```
Alternatively, you can load the `pylint_gitlab` plugin and then use the shortened `--output-format` names:
```sh
pylint --exit-zero --load-plugins=pylint_gitlab --output-format=gitlab-codeclimate . > codeclimate.json
pylint --exit-zero --load-plugins=pylint_gitlab --output-format=gitlab-pages-html . > pylint.html
```
### GitLab CI integration
Here is a minimalistic version for a `.gitlab-ci.yml` file:
```yaml
pylint:
stage: test
image: python:3.7-slim
before_script:
- mkdir -p public/badges public/lint
- echo undefined > public/badges/$CI_JOB_NAME.score
- pip install pylint-gitlab
script:
- pylint --exit-zero --output-format=text $(find -type f -name "*.py" ! -path "**/.venv/**") | tee /tmp/pylint.txt
- sed -n 's/^Your code has been rated at \([-0-9.]*\)\/.*/\1/p' /tmp/pylint.txt > public/badges/$CI_JOB_NAME.score
- pylint --exit-zero --output-format=pylint_gitlab.GitlabCodeClimateReporter $(find -type f -name "*.py" ! -path "**/.venv/**") > codeclimate.json
- pylint --exit-zero --output-format=pylint_gitlab.GitlabPagesHtmlReporter $(find -type f -name "*.py" ! -path "**/.venv/**") > public/lint/index.html
after_script:
- anybadge --overwrite --label $CI_JOB_NAME --value=$(cat public/badges/$CI_JOB_NAME.score) --file=public/badges/$CI_JOB_NAME.svg 4=red 6=orange 8=yellow 10=green
- |
echo "Your score is: $(cat public/badges/$CI_JOB_NAME.score)"
artifacts:
paths:
- public
reports:
codequality: codeclimate.json
when: always
pages:
stage: deploy
image: alpine:latest
script:
- echo
artifacts:
paths:
- public
only:
refs:
- master
```
You can then use the published badge for linting results.
[](https://smueller18.gitlab.io/pylint-gitlab/lint/)
```markdown
[](https://<MAIN_GROUP>.gitlab.io/<SUB_GROUP>/<PROJECT>/lint/)
```
%package -n python3-pylint-gitlab
Summary: This project provides pylint formatters for a nice integration with GitLab CI.
Provides: python-pylint-gitlab
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-pylint-gitlab
# pylint-gitlab
[](https://gitlab.com/smueller18/pylint-gitlab/commits/master)
[](https://smueller18.gitlab.io/pylint-gitlab/coverage/)
[](https://smueller18.gitlab.io/pylint-gitlab/lint/)
[](https://pypi.org/project/pylint-gitlab/)
This project provides pylint formatters for a nice integration with GitLab CI.
| Formatter | Description |
| --- | --- |
| `GitlabCodeClimateReporter` | Maps the linting result in [Code Climate format](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html) |
| `GitlabCodeClimateReporterNoHash` | Maps the linting result in [Code Climate format](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html) but without hashing the fingerprint. Needed to work with [nbQA](https://github.com/nbQA-dev/nbQA). |
| `GitlabPagesHtmlReporter` | Creates a table in an HTML page with linting results and links to source code. |
## Usage
Install package `pylint-gitlab`:
```sh
pip install pylint-gitlab
```
The `pylint` package is a dependency of `pylint-gitlab` so it will be installed automatically.
Now the formatters can be used by running `pylint` command and setting custom output formats with parameter `--output-format`.
```sh
pylint --exit-zero --output-format=pylint_gitlab.GitlabCodeClimateReporter . > codeclimate.json
pylint --exit-zero --output-format=pylint_gitlab.GitlabPagesHtmlReporter . > pylint.html
```
Alternatively, you can load the `pylint_gitlab` plugin and then use the shortened `--output-format` names:
```sh
pylint --exit-zero --load-plugins=pylint_gitlab --output-format=gitlab-codeclimate . > codeclimate.json
pylint --exit-zero --load-plugins=pylint_gitlab --output-format=gitlab-pages-html . > pylint.html
```
### GitLab CI integration
Here is a minimalistic version for a `.gitlab-ci.yml` file:
```yaml
pylint:
stage: test
image: python:3.7-slim
before_script:
- mkdir -p public/badges public/lint
- echo undefined > public/badges/$CI_JOB_NAME.score
- pip install pylint-gitlab
script:
- pylint --exit-zero --output-format=text $(find -type f -name "*.py" ! -path "**/.venv/**") | tee /tmp/pylint.txt
- sed -n 's/^Your code has been rated at \([-0-9.]*\)\/.*/\1/p' /tmp/pylint.txt > public/badges/$CI_JOB_NAME.score
- pylint --exit-zero --output-format=pylint_gitlab.GitlabCodeClimateReporter $(find -type f -name "*.py" ! -path "**/.venv/**") > codeclimate.json
- pylint --exit-zero --output-format=pylint_gitlab.GitlabPagesHtmlReporter $(find -type f -name "*.py" ! -path "**/.venv/**") > public/lint/index.html
after_script:
- anybadge --overwrite --label $CI_JOB_NAME --value=$(cat public/badges/$CI_JOB_NAME.score) --file=public/badges/$CI_JOB_NAME.svg 4=red 6=orange 8=yellow 10=green
- |
echo "Your score is: $(cat public/badges/$CI_JOB_NAME.score)"
artifacts:
paths:
- public
reports:
codequality: codeclimate.json
when: always
pages:
stage: deploy
image: alpine:latest
script:
- echo
artifacts:
paths:
- public
only:
refs:
- master
```
You can then use the published badge for linting results.
[](https://smueller18.gitlab.io/pylint-gitlab/lint/)
```markdown
[](https://<MAIN_GROUP>.gitlab.io/<SUB_GROUP>/<PROJECT>/lint/)
```
%package help
Summary: Development documents and examples for pylint-gitlab
Provides: python3-pylint-gitlab-doc
%description help
# pylint-gitlab
[](https://gitlab.com/smueller18/pylint-gitlab/commits/master)
[](https://smueller18.gitlab.io/pylint-gitlab/coverage/)
[](https://smueller18.gitlab.io/pylint-gitlab/lint/)
[](https://pypi.org/project/pylint-gitlab/)
This project provides pylint formatters for a nice integration with GitLab CI.
| Formatter | Description |
| --- | --- |
| `GitlabCodeClimateReporter` | Maps the linting result in [Code Climate format](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html) |
| `GitlabCodeClimateReporterNoHash` | Maps the linting result in [Code Climate format](https://docs.gitlab.com/ee/user/project/merge_requests/code_quality.html) but without hashing the fingerprint. Needed to work with [nbQA](https://github.com/nbQA-dev/nbQA). |
| `GitlabPagesHtmlReporter` | Creates a table in an HTML page with linting results and links to source code. |
## Usage
Install package `pylint-gitlab`:
```sh
pip install pylint-gitlab
```
The `pylint` package is a dependency of `pylint-gitlab` so it will be installed automatically.
Now the formatters can be used by running `pylint` command and setting custom output formats with parameter `--output-format`.
```sh
pylint --exit-zero --output-format=pylint_gitlab.GitlabCodeClimateReporter . > codeclimate.json
pylint --exit-zero --output-format=pylint_gitlab.GitlabPagesHtmlReporter . > pylint.html
```
Alternatively, you can load the `pylint_gitlab` plugin and then use the shortened `--output-format` names:
```sh
pylint --exit-zero --load-plugins=pylint_gitlab --output-format=gitlab-codeclimate . > codeclimate.json
pylint --exit-zero --load-plugins=pylint_gitlab --output-format=gitlab-pages-html . > pylint.html
```
### GitLab CI integration
Here is a minimalistic version for a `.gitlab-ci.yml` file:
```yaml
pylint:
stage: test
image: python:3.7-slim
before_script:
- mkdir -p public/badges public/lint
- echo undefined > public/badges/$CI_JOB_NAME.score
- pip install pylint-gitlab
script:
- pylint --exit-zero --output-format=text $(find -type f -name "*.py" ! -path "**/.venv/**") | tee /tmp/pylint.txt
- sed -n 's/^Your code has been rated at \([-0-9.]*\)\/.*/\1/p' /tmp/pylint.txt > public/badges/$CI_JOB_NAME.score
- pylint --exit-zero --output-format=pylint_gitlab.GitlabCodeClimateReporter $(find -type f -name "*.py" ! -path "**/.venv/**") > codeclimate.json
- pylint --exit-zero --output-format=pylint_gitlab.GitlabPagesHtmlReporter $(find -type f -name "*.py" ! -path "**/.venv/**") > public/lint/index.html
after_script:
- anybadge --overwrite --label $CI_JOB_NAME --value=$(cat public/badges/$CI_JOB_NAME.score) --file=public/badges/$CI_JOB_NAME.svg 4=red 6=orange 8=yellow 10=green
- |
echo "Your score is: $(cat public/badges/$CI_JOB_NAME.score)"
artifacts:
paths:
- public
reports:
codequality: codeclimate.json
when: always
pages:
stage: deploy
image: alpine:latest
script:
- echo
artifacts:
paths:
- public
only:
refs:
- master
```
You can then use the published badge for linting results.
[](https://smueller18.gitlab.io/pylint-gitlab/lint/)
```markdown
[](https://<MAIN_GROUP>.gitlab.io/<SUB_GROUP>/<PROJECT>/lint/)
```
%prep
%autosetup -n pylint-gitlab-1.2.0
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-pylint-gitlab -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 1.2.0-1
- Package Spec generated
|
