This project provides pylint formatters for a nice integration with GitLab CI.
Project description
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 |
GitlabPagesHtmlReporter |
Creates a table in an HTML page with linting results and links to source code. |
Usage
Install package pylint-gitlab
:
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
.
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:
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:
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.
[![pylint](https://<USER/GROUP_NAME>.gitlab.io/<PROJECT_PATH>/badges/pylint.svg)](https://<USER/GROUP_NAME>.gitlab.io/<PROJECT_PATH>/lint/)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pylint-gitlab-0.3.0.tar.gz
(7.2 kB
view hashes)
Built Distribution
Close
Hashes for pylint_gitlab-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 66af89ccd59c3417aded0223a305ecdb178e9c78d2f921d7c8dee4e7060d02fa |
|
MD5 | 6608727d1af4b599e6b5db8b90726496 |
|
BLAKE2b-256 | 4db20198ca9fb18ed446f673eeaa71ebf26886a3d9780182ac07faa01bf3e786 |