Readme
.. image:: https://img.shields.io/badge/license-Apache%202.0-blue.svg :alt: LICENSE :target: LICENSE
.. image:: https://travis-ci.org/carocad/CodeInk.svg?branch=master :target: https://travis-ci.org/carocad/CodeInk
.. image:: https://coveralls.io/repos/carocad/CodeInk/badge.svg?branch=master :target: https://coveralls.io/r/carocad/CodeInk?branch=master
.. image:: https://codeclimate.com/github/carocad/CodeInk/badges/gpa.svg :target: https://codeclimate.com/github/carocad/CodeInk :alt: 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.
.. image:: https://raw.githubusercontent.com/carocad/CodeInk/master/radon_art.png :alt: drawing of radon v1.2
the animations that CodeInk creates are base on:
squares = modules, circle = Python, cross = target module, class = diamond, function = triangle-up, method = triangle-downgreen = :) --> red = :(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
with pip::
pip3 install codeink
manually::
git clone https://github.com/carocad/CodeInk.git
python3 setup.py install
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
docopt v0.6.2 <https://pypi.python.org/pypi/docopt>_networkx v1.9.1 <https://pypi.python.org/pypi/networkx/1.9.1>_radon v1.2 <https://pypi.python.org/pypi/radon/1.2.1>_astunparse v1.2 <https://pypi.python.org/pypi/astunparse/1.2.2>_D3.js <http://d3js.org>_ (used automatically in the html head)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.
FAQs
codeink draws your Python source code into beautiful graph structures
We found that codeink demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Python Software Foundation has secured a 5-year sponsorship from Fastly that supports PSF's activities and events, most notably the security and reliability of the Python Package Index (PyPI).
Security News
LDAPjs, an LDAP Client and Server API for Node.js, was decommissioned after its maintainer received an abusive email from a user, raising concerns about this form of abuse as a potential attack vector.
Security News
CISA launched a new project called Vulnrichment to enrich CVEs with details that help prioritize patching and mitigation efforts, as the NVD backlog of unenriched CVEs awaiting analysis surpasses 10,000.