{ "info": { "author": "Camilo Roca", "author_email": "carocad@unal.edu.co", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Environment :: Console", "Intended Audience :: Developers", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.2", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Topic :: Software Development", "Topic :: Software Development :: Quality Assurance", "Topic :: Utilities" ], "description": "=======\r\nCodeInk\r\n=======\r\n.. image:: https://img.shields.io/badge/license-Apache%202.0-blue.svg\r\n :alt: LICENSE\r\n :target: LICENSE\r\n \r\n.. image:: https://travis-ci.org/carocad/CodeInk.svg?branch=master\r\n :target: https://travis-ci.org/carocad/CodeInk\r\n\r\n.. image:: https://coveralls.io/repos/carocad/CodeInk/badge.svg?branch=master\r\n :target: https://coveralls.io/r/carocad/CodeInk?branch=master\r\n \r\n.. image:: https://codeclimate.com/github/carocad/CodeInk/badges/gpa.svg\r\n :target: https://codeclimate.com/github/carocad/CodeInk\r\n :alt: Code Climate\r\n\r\nCodeInk is a Python source code analyzer focused on complexity and interrelation of modules.\r\n\r\nCodeInk draws the ihnerent relations of your modules along with their complexity and\r\nmaintanability indexes in a beautiful graph powered by D3.js.\r\n\r\n.. image:: https://raw.githubusercontent.com/carocad/CodeInk/master/radon_art.png\r\n :alt: drawing of radon v1.2\r\n\r\n- drawing of radon v1.2\r\n- hover over a rounded rectangle to check which module is it\r\n\r\no.O?\r\n----\r\n\r\nthe animations that CodeInk creates are base on:\r\n\r\n* symbols: ``squares = modules``, ``circle = Python``, ``cross = target module``, ``class = diamond``, ``function = triangle-up``, ``method = triangle-down``\r\n* lines: each line represents an import\r\n* color: module maintainability index ``green = :)`` --> ``red = :(``\r\n* size: ciclomatic complexity ``small = :)`` --> ``big = :(``\r\n\r\n*hint: if A imports B, and B imports C, then A imports B and C, right?*\r\nA --> B, B --> C, A --> B & C\r\n\r\ninstall\r\n=======\r\nwith pip::\r\n\r\n pip3 install codeink\r\n \r\nmanually::\r\n\r\n git clone https://github.com/carocad/CodeInk.git\r\n python3 setup.py install\r\n\r\nusage\r\n=====\r\n\r\ndraw a package structure::\r\n\r\n codeink draw /path/to/project\r\n\r\ntrace a module's imports::\r\n\r\n codeink trace /path/to/module.py\r\n\r\ncheck who imports a module::\r\n\r\n codeink blame /path/to/module.py\r\n\r\nget an overview of a module::\r\n\r\n codeink portrait /path/to/module.py\r\n\r\nrequirements\r\n============\r\n* python v2.6 - v3.4\r\n* `docopt v0.6.2 `_\r\n* `networkx v1.9.1 `_\r\n* `radon v1.2 `_\r\n* `astunparse v1.2 `_\r\n* `D3.js `_ (used automatically in the html head)\r\n\r\nnotes\r\n=====\r\nIn 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.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/carocad/codeInk", "keywords": "graph,drawings,module,complexity,maintainability,imports,structure", "license": "Apache license 2.0", "maintainer": "", "maintainer_email": "", "name": "codeink", "package_url": "https://pypi.org/project/codeink/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/codeink/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/carocad/codeInk" }, "release_url": "https://pypi.org/project/codeink/1.0/", "requires_dist": null, "requires_python": null, "summary": "codeink draws your Python source code into beautiful graph structures", "version": "1.0" }, "last_serial": 1609029, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "efad2942280f26c9e5fed4480e747271", "sha256": "47ae4ef0dfb82c53a46a74602a7cb235b6d95d91e83b5ff56390219718ae22f0" }, "downloads": -1, "filename": "codeink-1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "efad2942280f26c9e5fed4480e747271", "packagetype": "bdist_wheel", "python_version": "3.4", "requires_python": null, "size": 16579, "upload_time": "2015-06-26T19:12:14", "url": "https://files.pythonhosted.org/packages/ee/57/6ffd41032266ece6b195fc243a0726d7dedad14c36227bf30188785cdd51/codeink-1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "249ad846eb699fd50aec79478bb2fa02", "sha256": "34167618ceef0c94247d5a554ef88e6d5c0215ff7d37fb00750e0822cbe73b48" }, "downloads": -1, "filename": "codeink-1.0.tar.gz", "has_sig": false, "md5_digest": "249ad846eb699fd50aec79478bb2fa02", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11165, "upload_time": "2015-06-26T19:12:10", "url": "https://files.pythonhosted.org/packages/d1/fa/b6d9335968f5d5d5a736dfd915570894e92094b2b82d9ad9ff719e565239/codeink-1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "efad2942280f26c9e5fed4480e747271", "sha256": "47ae4ef0dfb82c53a46a74602a7cb235b6d95d91e83b5ff56390219718ae22f0" }, "downloads": -1, "filename": "codeink-1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "efad2942280f26c9e5fed4480e747271", "packagetype": "bdist_wheel", "python_version": "3.4", "requires_python": null, "size": 16579, "upload_time": "2015-06-26T19:12:14", "url": "https://files.pythonhosted.org/packages/ee/57/6ffd41032266ece6b195fc243a0726d7dedad14c36227bf30188785cdd51/codeink-1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "249ad846eb699fd50aec79478bb2fa02", "sha256": "34167618ceef0c94247d5a554ef88e6d5c0215ff7d37fb00750e0822cbe73b48" }, "downloads": -1, "filename": "codeink-1.0.tar.gz", "has_sig": false, "md5_digest": "249ad846eb699fd50aec79478bb2fa02", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11165, "upload_time": "2015-06-26T19:12:10", "url": "https://files.pythonhosted.org/packages/d1/fa/b6d9335968f5d5d5a736dfd915570894e92094b2b82d9ad9ff719e565239/codeink-1.0.tar.gz" } ] }