Metadata-Version: 1.1
Name: clockit
Version: 0.2.1
Summary: Tool for timing the execution of Python functions
Home-page: https://github.com/rlucioni/clockit
Author: Renzo Lucioni
Author-email: renzo@lucioni.email
License: MIT
Description: clockit |Travis|_
        =================
        .. |Travis| image:: https://travis-ci.org/rlucioni/clockit.svg?branch=master
        .. _Travis: https://travis-ci.org/rlucioni/clockit
        
        Tool for timing the execution of Python functions.
        
        Installation
        ------------
        
        Install with ``pip``::
        
            pip install clockit
        
        Usage
        -----
        
        Run as follows::
        
            $ python
            >>> from clockit import clockit
            >>> def f(x, y=1):
            ...     return x, y
            ...
            >>> clocked = clockit(f, 1, y=2)
            >>> clocked.result
            (1, 2)
            >>> clocked.time
            0.0005593200330622494
        
        ``clockit`` uses the ``timeit`` module which accepts objects that are callable without arguments.
        
        Distribution
        ------------
        
        Install requirements::
        
            $ pip install -r requirements.txt
        
        Bump the package version, then build a source distribution and a wheel::
        
            $ python setup.py sdist bdist_wheel 
        
        Register the project with the PyPI test server::
        
            $ python setup.py register -r test
        
        Use ``twine`` to safely upload previously built distributions to the PyPI test server::
        
            $ twine upload -r test dist/clockit-<version>*
        
        If all is well, register the project with PyPI::
        
            $ python setup.py register
        
        Finally, use ``twine`` to safely upload distributions to PyPI::
        
            $ twine upload dist/clockit-<version>*
        
Keywords: clockit
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development :: Libraries :: Python Modules
