Skip to content

Commit

Permalink
Update readme with two FAQs. Closes #14.
Browse files Browse the repository at this point in the history
  • Loading branch information
theotherbjorn committed May 3, 2020
1 parent b920b58 commit 8c9afdb
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,15 @@ From the shell::

Detailed usage examples can be found below the version history.

**Note:** pydeps finds imports by looking for import-opcodes in
python bytecodes (think `.pyc` files). Therefore, only imported files
will be found (ie. pydeps will not look at files in your directory that
are not imported). Additionally, only files that can be found using
the Python import machinery will be considered (ie. if a module is
missing or not installed, it will not be included regardless if it is
being imported). This can be modified by using the ``--inlcude-missing``
flag described below.

**Creating the graph:**

To create graphs you need to install Graphviz_ Please follow the
Expand Down Expand Up @@ -337,6 +346,7 @@ optional arguments:
--max-bacon INT exclude nodes that are more than n hops away (default=2, 0 -> infinite)
--pylib include python std lib modules
--pylib-all include python all std lib modules (incl. C modules)
--include-missing include modules that are not installed (or can't be found on sys.path)
--x PATTERN, --exclude PATTERN input files to skip (e.g. `foo.*`), multiple patterns can be provided
--xx MODULE, --exclude-exact MODULE same as --exclude, except requires the full match. `-xx foo.bar` will exclude foo.bar, but not foo.bar.blob
--only MODULE_PATH only include modules that start with MODULE_PATH, multiple paths can be provided
Expand Down

3 comments on commit 8c9afdb

@fabiosangregorio
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo on row 43 "inlcude-missing" instead of "include-missing" :)

@thebjorn
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bah!

@thebjorn
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix'd.

Please sign in to comment.