Skip to main content

codeink draws your Python source code into beautiful graph structures

Project description

LICENSE https://travis-ci.org/carocad/CodeInk.svg?branch=master https://coveralls.io/repos/carocad/CodeInk/badge.svg?branch=master Code Climate

CodeInk is a Python source code analyzer focused on complexity and interrelation of modules.

CodeInk draws the ihnerent relations of your modules along with their complexity and maintanability indexes in a beautiful graph powered by D3.js.

drawing of radon v1.2
  • drawing of radon v1.2
  • hover over a rounded rectangle to check which module is it

o.O?

the animations that CodeInk creates are base on:

  • symbols: squares = modules, circle = Python, cross = target module, class = diamond, function = triangle-up, method = triangle-down
  • lines: each line represents an import
  • color: module maintainability index green = :) –> red = :(
  • size: ciclomatic complexity small = :) –> big = :(

hint: if A imports B, and B imports C, then A imports B and C, right? A –> B, B –> C, A –> B & C

install

with pip:

pip3 install codeink

manually:

git clone https://github.com/carocad/CodeInk.git
python3 setup.py install

usage

draw a package structure:

codeink draw /path/to/project

trace a module’s imports:

codeink trace /path/to/module.py

check who imports a module:

codeink blame /path/to/module.py

get an overview of a module:

codeink portrait /path/to/module.py

requirements

notes

In order to use CodeInk you must make sure that your python version uses the same syntax as the code that you are analyzing i.e. analyzing a code written with Python v2.7 syntax while using Python v3.x will result in an error.

Project details


Release history Release notifications

This version

1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for codeink, version 1.0
Filename, size File type Python version Upload date Hashes
Filename, size codeink-1.0-py3-none-any.whl (16.6 kB) File type Wheel Python version 3.4 Upload date Hashes View hashes
Filename, size codeink-1.0.tar.gz (11.2 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page