Skip to content

Commit

Permalink
docs: document known-first-party option
Browse files Browse the repository at this point in the history
  • Loading branch information
mkniewallner committed Jan 2, 2023
1 parent 14a97ba commit 3dc7137
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,24 @@ requirements_txt_dev = ["requirements-dev.txt", "requirements-tests.txt"]
deptry . --requirements-txt-dev requirements-dev.txt,requirements-tests.txt
```

#### Known first party

List of Python modules that should be considered as first party ones. This is useful in case _deptry_ is not able to automatically detect modules that should be considered as local ones.

- Type: `List[str]`
- Default: `[]`
- `pyproject.toml` option name: `known_first_party`
- CLI option name: `--known-first-party` (short: `-kf`)
- `pyproject.toml` example:
```toml
[tool.deptry]
known_first_party = ["bar", "foo"]
```
- CLI example:
```shell
deptry . --known-first-party bar --known-first-party foo
```

#### JSON output

Write the detected issues to a JSON file. This will write the following kind of output:
Expand Down

0 comments on commit 3dc7137

Please sign in to comment.