README.md

alkh [al-khwarizmi]

Algorithmic python debugging

1. Convert your debugger stack to jupyter notebook

2. Focus on code pathways using local web application

Installation

pip install alkh

Convert your debugger stack to jupyter notebook

API

function name: take_it_offline

description: create jupyter notebook based on the program stack

parameters:

notebook_dir_path: Optional[str] = None, directory path to save the notebook in

levels: Optional[int] = 1, number of program stack layers to put in notebook

Usage

import alkh

alkh.take_it_offline('path-of-notebooks-directory')

or

alkh.take_it_offline('path-of-notebooks-directory', levels=2)

or

bash:

export ALKH_NOTEBOOKS_PATH='path-to-notebooks-directory'

python:

import alkh

alkh.take_it_offline()

or

alkh.take_it_offline(levels=2)

Usage flow example

Stop at breakpoint within PyCharm

Use Console to run code within debugger

Run: import alkh

Run: alkh.take_it_offline('path-of-notebooks-directory')

Start Jupyter

Run the notebook

Focus on code pathways using local web application

API

function name: analyze

description: launches web application to analyze code pathways

parameters:None

Usage

import alkh
alkh.analyze()

Usage flow example

Add two line to top of file
Run the file
Analyze your code