@@ -23,7 +23,7 @@ Assuming your project follows a layout like the suggested `sample project`_::
23
23
Basic usage, running in your project directory::
24
24
25
25
<activate virtualenv for your project>
26
- pip-missing-reqs --ignore-files =sample/tests/* sample
26
+ pip-missing-reqs --ignore-file =sample/tests/* sample
27
27
28
28
This will find all imports in the code in "sample" and check that the
29
29
packages those modules belong to are in the requirements.txt file.
@@ -36,7 +36,7 @@ To make your life easier, copy something like this into your tox.ini::
36
36
37
37
[pip-missing-reqs]
38
38
deps=-rrequirements.txt
39
- commands=pip-missing-reqs --ignore-files =sample/tests/* sample
39
+ commands=pip-missing-reqs --ignore-file =sample/tests/* sample
40
40
41
41
42
42
Excluding test files (or others) from this check
@@ -47,19 +47,19 @@ application source ("sample" in the above examples). The requirements for
47
47
those tests generally should not be in the requirements.txt file, and you
48
48
don't want this tool to generate false hits for those.
49
49
50
- You may exclude those test files from your check using the --ignore-files
51
- option.
50
+ You may exclude those test files from your check using the ` --ignore-file `
51
+ option (shorthand is ` -f `). Multiple instances of the option are allowed .
52
52
53
53
54
54
Excluding modules from the check
55
55
--------------------------------
56
56
57
57
If your project has modules which are conditionally imported, or requirements
58
58
which are conditionally included, you may exclude certain modules from the
59
- check by name (or glob pattern) using --ignore-mods ::
59
+ check by name (or glob pattern) using ` --ignore-module ` (shorthand is ` -m `) ::
60
60
61
61
# ignore the module spam
62
- pip-missing-reqs --ignore-mods =spam sample
62
+ pip-missing-reqs --ignore-module =spam sample
63
63
# ignore the whole package spam as well
64
- pip-missing-reqs --ignore-mods =spam --ignore-mods =spam.* sample
64
+ pip-missing-reqs --ignore-module =spam --ignore-module =spam.* sample
65
65
0 commit comments