You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
also add a big warning statement about possible side effects and
to deter people from reporting issues about Django version
mismatches. Updates README formatting a bit as well.
Copy file name to clipboardExpand all lines: README.md
+23-9Lines changed: 23 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -10,19 +10,33 @@ pylint-django
10
10
11
11
`pylint-django` is a [Pylint](http://pylint.org) plugin for improving code analysis for when analysing code using Django. It is also used by the [Prospector](https://github.com/landscapeio/prospector) tool.
12
12
13
-
## Usage
13
+
#Installation
14
14
15
-
#### Pylint
15
+
```
16
+
pip install pylint-django
17
+
```
18
+
19
+
**WARNING:**`pylint-django` requires `Django` to be installed. Our `setup.py` file doesn't
20
+
specify which particular version of Django is going to be installed because we have no idea
21
+
what version is used inside your project. The latest version of Django will be installed if
22
+
it has not been installed beforehand! DO NOT report issues about mismatching Django versions
23
+
if that happens. Instead get your testing environment sorted out and make sure that you have
24
+
the appropriate version of Django installed!
25
+
26
+
# Usage
27
+
28
+
## Pylint
16
29
17
-
Ensure `pylint-django` is installed and on your path (`pip install pylint-django`), and then run pylint:
30
+
Ensure `pylint-django` is installed and on your path and then execute:
If you have `prospector` installed, then `pylint-django` will already be installed as a dependency, and will be activated automatically if Django is detected.
38
+
If you have `prospector` installed, then `pylint-django` will already be installed as a dependency,
39
+
and will be activated automatically if Django is detected.
26
40
27
41
```
28
42
prospector [..other options..]
@@ -42,14 +56,14 @@ Please feel free to add your name to the `CONTRIBUTORS.md` file if you want to b
42
56
credited when pull requests get merged. You can also add to the `CHANGELOG.md` file
43
57
if you wish, although I'll also do that when merging if not.
44
58
45
-
##Tests
59
+
# Tests
46
60
47
61
The structure of the test package follows that from pylint itself.
48
62
49
63
It is fairly simple: create a module starting with `func_` followed by
50
64
a test name, and insert into it some code. The tests will run pylint
51
-
against these modules. If the idea is that no messages now occur, then
52
-
that is fine, just check to see if it works by running `scripts/test.sh`.
65
+
against these modules. If the idea is that no messages now occur, then
66
+
that is fine, just check to see if it works by running `scripts/test.sh`.
53
67
54
68
Ideally, add some pylint error suppression messages to the file to prevent
55
69
spurious warnings, since these are all tiny little modules not designed to
@@ -64,4 +78,4 @@ These are useful to quickly add "expected messages".
64
78
65
79
# License
66
80
67
-
`pylint-django` is available under the GPLv2 license.
81
+
`pylint-django` is available under the GPLv2 license.
0 commit comments