Metadata-Version: 2.0
Name: block-timer
Version: 0.1.1
Summary: Measure execution time of your code blocks
Home-page: https://github.com/illagrenan/block-timer
Author: Vasek Dohnal
Author-email: vaclav.dohnal@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Operating System :: OS Independent

=======================================================
Block Timer: Measure execution time of your code blocks
=======================================================

.. image:: https://img.shields.io/pypi/v/block-timer.svg
        :target: https://pypi.python.org/pypi/block-timer
        :alt: PyPi

.. image:: https://img.shields.io/badge/license-MIT-blue.svg
        :target: https://pypi.python.org/pypi/block-timer/
        :alt: MIT

.. image:: https://img.shields.io/travis/illagrenan/block-timer.svg
        :target: https://travis-ci.org/illagrenan/block-timer
        :alt: TravisCI

.. image:: https://img.shields.io/coveralls/illagrenan/block-timer.svg
        :target: https://coveralls.io/github/illagrenan/block-timer?branch=master
        :alt: Coverage

.. image:: https://pyup.io/repos/github/illagrenan/block-timer/shield.svg
     :target: https://pyup.io/repos/github/illagrenan/block-timer/
     :alt: Updates

.. image:: https://img.shields.io/pypi/implementation/block-timer.svg        
	:target: https://pypi.python.org/pypi/django_brotli/         
	:alt: Supported Python implementations      

.. image:: https://img.shields.io/pypi/pyversions/block-timer.svg    
	:target: https://pypi.python.org/pypi/django_brotli/             
	:alt: Supported Python versions    

Installation
------------

- Supported Python versions are: ``3.5``, ``3.6-dev`` and ``3.7-dev``.

.. code:: shell

    pip install --upgrade block-timer

Usage
-----

You can easily measure blocks of code using ``Timer`` class as context manager or as method/function decorator with Block Timer:

Elapsed time will be printed using standard ``print`` function:

.. code:: python

    from block_timer.timer import Timer

    with Timer():
        pass # Some operation

    # Total time ... seconds will be printed

If you have multiple blocks of code, you can set ``title`` attribute:

.. code:: python

    from block_timer.timer import Timer

    with Timer(title="Block A"):
        pass # Some operation

    # [Block A] Total time ... seconds will be printed

    with Timer(title="Block B"):
        pass # Some operation

    # [Block B] Total time ... seconds will be printed

Elapsed time (in fractional seconds) can be accessed by ``elapsed`` property:

.. code:: python

    from block_timer.timer import Timer

    with Timer() as t:
        pass # Some operation

    print("Elapsed time: {:f} seconds".format(t.elapsed))


``Timer`` class can be used as a method/function decorator:

.. code:: python

    @Timer(title="Foo")
    def some_func():
        time.sleep(1)

    some_func()
    # [Foo] Total time ... seconds will be printed

Resources
---------

- `time.perf_counter() on Python Doc <https://docs.python.org/3/library/time.html#time.perf_counter>`_


License
-------

The MIT License (MIT)

Copyright (c) 2016 Vašek Dohnal (@illagrenan)

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


