Metadata-Version: 1.1
Name: codehint
Version: 0.0.1
Summary: CodeHint is a package for describing python functions and methods in console during runtime.
Home-page: http://github.com/ipazc/codehint
Author: Iván de Paz Centeno
Author-email: ipazc@unileon.es
License: MIT
Description: ==============
        CodeHint 0.0.1
        ==============
        
        `CodeHint` is a package for describing a function within the python console during runtime.
        It works in the same way as an advanced IDE does when it displays the hint for function, but pretty-printing to
        console rather than to a window.
        
        .. image:: https://badge.fury.io/py/codehint.svg
            :target: https://badge.fury.io/py/codehint
        .. image:: https://travis-ci.org/ipazc/codehint.svg?branch=master
            :target: https://travis-ci.org/ipazc/codehint
        .. image:: https://coveralls.io/repos/github/ipazc/codehint/badge.svg?branch=master
            :target: https://coveralls.io/github/ipazc/codehint?branch=master
        
        
        Example
        =======
        
        If we have the following function defined somewhere in our code:
        
        .. code:: python
        
            >>> def hello(a, b:int, c) -> int:
            ...     """
            ...     Hello, this is an explanation
            ...     of what this is going to do
            ...     :param a: foo
            ...     :param b: bar example
            ...     :param c:
            ...     :return: True if good, False otherwise.
            ...     """
            ...     x = a + b * 2*c
            ...     return x
        
        It can be described later on with `CodeHint`:
        
        .. code:: python
        
            >>> from codehint import hint
            >>> hint(hello)
        
        The result is
        
        .. code:: bash
        
            ------------------------
            def hello(a, b:int, c) -> int:
            
                Hello, this is an explanation of what this is going to do
            
            === Parameters: 3 ======
             [0] a (type Any) ->   foo
             [1] b (type int) ->   bar example
             [2] c (type Any) ->  
            ========================
             Result (type int) ->  True if good, False otherwise.
        
        `CodeHint` currently can only be used to describe the signature of functions or methods.
        
        Installation
        ============
        
        It is only supported **Python 3.4.1** onwards:
        
        .. code:: bash
        
            sudo pip3 install codehint
        
        
        LICENSE
        =======
        
        It is released under the *MIT license*.
        
Keywords: hint functions python console runtime describe code
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
