From 58f484f2b2605c44a075483a02642a6af0af5893 Mon Sep 17 00:00:00 2001 From: Fredrik Averpil Date: Thu, 16 Mar 2023 20:46:24 +0100 Subject: [PATCH] docs: update docs on --exclude-deps --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 19858cd4..73054cf9 100644 --- a/README.md +++ b/README.md @@ -86,6 +86,12 @@ When using `requirements.txt` files to specify dependencies, there is no way to Yes, you can specify a list of sections after the `--sections` argument. It all depends on what your setup looks like and what you set out to achieve. +### Can I exclude dependencies from the scan? + +Yes, you can use the `--exclude-deps` argument to specify one or more dependencies you do not wish to get warnings for. + +This feature meant to be used for dependencies you must specify in your dependencies spec file, but which you don't necessarily import in your source code. An example of such a dependency are database drivers, which are commonly only defined in connection strings and will signal to the ORM which driver to use. + ### Can I run Creosote in a GitHub Action workflow? Yes, please see the `action` job example in [`.github/workflows/test.yml`](.github/workflows/test.yml).