Home | History | Annotate | Download | only in doc
      1 Commandline tools
      2 =================
      3 
      4 The package can be used as a script using "python -mmodulegraph".
      5 
      6 This script calculates the module graph for the scripts passed
      7 on the commandline and by default prints a list of modules
      8 in the objectgraph, and their type and location.
      9 
     10 The script has a number of options to change the output:
     11 
     12 * ``-d``: Increase the debug level
     13 
     14 * ``-q``: Clear the debug level (emit minimal output)
     15 
     16 * ``-m``: The arguments are module names instead of script files
     17 
     18 * ``-x name``: Add ``name`` to the list of excludes
     19 
     20 * ``-p path``: Add ``path`` to the module search path
     21 
     22 * ``-g``: Emit a ``.dot`` file instead of a list of modules
     23 
     24 * ``-h``: Emit a ``.html`` file instead of a list of modules
     25 
     26 Deprecation warning
     27 -------------------
     28 
     29 The package also installs a command-line tool named "modulegraph",
     30 this command-line tool is deprecated and will be removed in a
     31 future version.
     32