Skip to content

Latest commit

 

History

History
73 lines (62 loc) · 3.62 KB

README.md

File metadata and controls

73 lines (62 loc) · 3.62 KB
Raw

Panoptisch: A recursive dependency scanner for Python projects

Downloads

⚠️🚨 Early stage! May not work as expected! Feedback welcome! 🚨⚠️

See: Introduction Video

What?

Panoptisch scans your Python file or module to find it's imports (aka dependencies) and recursively does so for all dependencies and sub-dependencies. It then generates a dependency tree in JSON for you to parse and enforce import policies. Imports are resolved by mimicing Python's import system. It's completely static besides the importing of modules to find the location of its source file(s). Panoptisch also features a minimal sandbox to prevent side-effects when importing dependencies. Note that the sandbox is not foolproof!

Please NOTE:

There are known limitations and issues at this stage. Please read this before using Panoptisch.
See: LIMITATIONS.md LINK.

Motivation

I was not able to find a proper dependency scanner for Python. Panoptisch was born out of the need to accurately verify dependency usage accross an entire project.
It's aim is to generate a JSON report that can be parsed and evaluated to assert import policies.
For example, you may want to restrict os, socket, sys and importlib imports to selected packages.

Usage

  1. Install Panoptisch in the same virtual environment as your project, this is important!
pip install panoptisch
  1. Use
usage: panoptisch <module>

positional arguments:
  module                Name of module or file you wish to scan.

options:
  -h, --help            show this help message and exit.
  --show-stdlib-dir     Prints the automatically resolved stdlib directory.
  --max-depth MAX_DEPTH
                        Maximum dependency depth.
  --out OUT             File to output report.
  --auto-stdlib-dir     Ignore stdlib modules by automatically resolving their path. MAY BE BUGGY. Try running panoptisch <module_name> --show-stdlib-dir to see the directory before using this.
  --stdlib-dir STDLIB_DIR Ignore stdlib modules by providing their path.
  --omit-not-found      Do not include modules that could not be resolved in report.
  --no-sandbox          Ignore the minimal sandbox implementation.

A typical run may be

$ panoptisch <module or file> --max-depth 5 --omit-not-found
  1. See report
$ more out.json
  1. We might not be interested in the dependencies of standard library modules as we place an implicit trust in them.
    To filter them out, use the --show-stdlib-dir arguement to see if Panoptisch can automatically resolve your standard library directory, typically /usr/local/lib/python3.x on linux installations. Then you can exclude it using
$ panoptisch <module or file> --auto-stdlib-dir

If Panoptisch cannot automatically resolve your standard library directory, you can find it yourself and provide it as an argument to stdlib-dir

$ panoptisch <module or file> --stdlib-dir /the/path/to/your/standardlibrary/

LICENSE

All work is licensed under the GNU General Public License Version 3.

Contributing

Feedback, contributions and issues welcome.