{ "info": { "author": "Iv\u00e1n de Paz Centeno", "author_email": "ipazc@unileon.es", "bugtrack_url": null, "classifiers": [ "Environment :: Console", "Intended Audience :: Developers", "Intended Audience :: Education", "Intended Audience :: Science/Research", "Natural Language :: English", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "==============\nCodeHint 0.0.1\n==============\n\n`CodeHint` is a package for describing a function within the python console during runtime.\nIt works in the same way as an advanced IDE does when it displays the hint for function, but pretty-printing to\nconsole rather than to a window.\n\n.. image:: https://badge.fury.io/py/codehint.svg\n :target: https://badge.fury.io/py/codehint\n.. image:: https://travis-ci.org/ipazc/codehint.svg?branch=master\n :target: https://travis-ci.org/ipazc/codehint\n.. image:: https://coveralls.io/repos/github/ipazc/codehint/badge.svg?branch=master\n :target: https://coveralls.io/github/ipazc/codehint?branch=master\n\n\nExample\n=======\n\nIf we have the following function defined somewhere in our code:\n\n.. code:: python\n\n >>> def hello(a, b:int, c) -> int:\n ... \"\"\"\n ... Hello, this is an explanation\n ... of what this is going to do\n ... :param a: foo\n ... :param b: bar example\n ... :param c:\n ... :return: True if good, False otherwise.\n ... \"\"\"\n ... x = a + b * 2*c\n ... return x\n\nIt can be described later on with `CodeHint`:\n\n.. code:: python\n\n >>> from codehint import hint\n >>> hint(hello)\n\nThe result is\n\n.. code:: bash\n\n ------------------------\n def hello(a, b:int, c) -> int:\n \n Hello, this is an explanation of what this is going to do\n \n === Parameters: 3 ======\n [0] a (type Any) -> foo\n [1] b (type int) -> bar example\n [2] c (type Any) -> \n ========================\n Result (type int) -> True if good, False otherwise.\n\n`CodeHint` currently can only be used to describe the signature of functions or methods.\n\nInstallation\n============\n\nIt is only supported **Python 3.4.1** onwards:\n\n.. code:: bash\n\n sudo pip3 install codehint\n\n\nLICENSE\n=======\n\nIt is released under the *MIT license*.\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/ipazc/codehint", "keywords": "hint functions python console runtime describe code", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "codehint", "package_url": "https://pypi.org/project/codehint/", "platform": "", "project_url": "https://pypi.org/project/codehint/", "project_urls": { "Homepage": "http://github.com/ipazc/codehint" }, "release_url": "https://pypi.org/project/codehint/0.0.1/", "requires_dist": null, "requires_python": "", "summary": "CodeHint is a package for describing python functions and methods in console during runtime.", "version": "0.0.1" }, "last_serial": 3328991, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "1bc8bdf34494bca9a23ba9254f247e2c", "sha256": "cb5dc624b5722f1f5333f6d87d14f70a4f9259624539f1ec7b615b15d9a8beee" }, "downloads": -1, "filename": "codehint-0.0.1.tar.gz", "has_sig": false, "md5_digest": "1bc8bdf34494bca9a23ba9254f247e2c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5310, "upload_time": "2017-11-13T16:10:39", "url": "https://files.pythonhosted.org/packages/0c/e9/7024c2f3a3f409b3e4d59509d673468f48eb6423e2e42fb4aa1a95bc4ee6/codehint-0.0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1bc8bdf34494bca9a23ba9254f247e2c", "sha256": "cb5dc624b5722f1f5333f6d87d14f70a4f9259624539f1ec7b615b15d9a8beee" }, "downloads": -1, "filename": "codehint-0.0.1.tar.gz", "has_sig": false, "md5_digest": "1bc8bdf34494bca9a23ba9254f247e2c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 5310, "upload_time": "2017-11-13T16:10:39", "url": "https://files.pythonhosted.org/packages/0c/e9/7024c2f3a3f409b3e4d59509d673468f48eb6423e2e42fb4aa1a95bc4ee6/codehint-0.0.1.tar.gz" } ] }