OOP Viewer 🕸️

A CLI tool to produce interactive visualisations of OOP inheritance in Python projects.

Examples

Scikit-Learn - Ensemble Module

FastAPI - Everything

MLFlow - Classes Inheriting Exception

Usage

On an individual file

oop_viewer examples/dummy_python.py

On a module

oop_viewer examples

Including a specified class

oop_viewer examples OtherChildClass

Backlog

• Multiple Inheritance
• Colour nodes based on file
• Disambiguiting overlapping nodes
• Allowing for passing of class across module

How to build

Currently building is done manually until precompiled binaries are distributed.

To build the tool you'll need to install Rust and Cargo. The Rust Foundation Book has really good documentation for how to install both. Once these are installed, clone the repo and do the following:

1. Build the binary

cargo build --release

2. Install the binary globally

cargo install --path .

3. Add ~/.cargo/bin to $PATH

export PATH="$HOME/.cargo/bin:$PATH"