Skip to content

Commit

Permalink
General fixes on documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
louisjdmartin committed Apr 13, 2022
1 parent 14a65b9 commit a106031
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ cnes-pylint-extension checks the following rules :

cnes-pylint-extension checks the following metrics :
- R5301 - too-high-complexity (default < 25)
- R5302 - too-high-complexity-simplified (defailt < 20)
- R5302 - too-high-complexity-simplified (default < 20)
- R5201 - too-few-comments (default > 20%)

# Available versions :
Expand All @@ -30,11 +30,16 @@ cnes-pylint-extension checks the following metrics :

# To use these checkers:

## Install Pylint
## Install from PIP
`pip install cnes-pylint-extension`

## Install from sources

### Install Pylint

`pip install pylint==2.5.0`

## Install CNES Pylint extension checkers
### Install CNES Pylint extension checkers

Download the project's code source then add the checkers subdirectory to your PYTHONPATH :

Expand All @@ -52,6 +57,8 @@ load-plugins=cnes_checker
...
```

## Usage

Pylint is now able to use the extension.

Otherwise, add `--load-plugins=cnes_checker` to your pylint command line in order to activate it.
7 changes: 5 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
name="cnes-pylint-extension",
version="5.0.0",
author="CNES CatLab",
description="A PyLint plugin that can output to SonarQube-importable JSON",
description="A PyLint plugin to add coding CNES specific checks",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://github.com/cnescatlab/cnes-pylint-extension",
Expand All @@ -16,12 +16,15 @@
license_file='LICENSE',
classifiers=[
"Programming Language :: Python :: 3",
"License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
"License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
"Operating System :: OS Independent",
],
python_requires='>=3.6',
install_requires=[
"pylint-plugin-utils==0.7",
"pylint==2.5.0"
],
project_urls={
'Bug Reports': 'https://github.com/cnescatlab/cnes-pylint-extension/issues'
}
)

0 comments on commit a106031

Please sign in to comment.