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 | RSS feed

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.

Source Distribution

codeink-1.0.tar.gz (11.2 kB view details)

Uploaded Source

Built Distribution

codeink-1.0-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

Details for the file codeink-1.0.tar.gz.

File metadata

  • Download URL: codeink-1.0.tar.gz
  • Upload date:
  • Size: 11.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for codeink-1.0.tar.gz
Algorithm Hash digest
SHA256 34167618ceef0c94247d5a554ef88e6d5c0215ff7d37fb00750e0822cbe73b48
MD5 249ad846eb699fd50aec79478bb2fa02
BLAKE2b-256 d1fab6d9335968f5d5d5a736dfd915570894e92094b2b82d9ad9ff719e565239

See more details on using hashes here.

File details

Details for the file codeink-1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for codeink-1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 47ae4ef0dfb82c53a46a74602a7cb235b6d95d91e83b5ff56390219718ae22f0
MD5 efad2942280f26c9e5fed4480e747271
BLAKE2b-256 ee576ffd41032266ece6b195fc243a0726d7dedad14c36227bf30188785cdd51

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page