/sloth

The best python speedtesting library and command line speedtesting tool

Primary LanguagePythonMIT LicenseMIT

sloth

The python speedtesting library and command line tool

codecov Build Status Codacy Badge License: MIT Contributors Last Commit Documentation Status

sloth is a Python package for speedtesting python code and functions with as little code as necessary. It's easy to use and, unlike many projects, has decent documentation.

The idea behind this API is:

>>> from sloth import compare_sloth
>>> import timeit
>>> compare_sloth(timeit)
'sloth is loads better than timeit!'

See? described in 3 lines. Everything that timeit can do, sloth can do better - or will soon. And alot of things timeit can't do sloth can do anyway.

A Quick Example

>>> from sloth.simple import time_callable
>>> import time
>>> def my_func(a, b, c):
...     time.sleep(1)
...     print(a, b, c)
>>> time_callable(my_func, 2, 'a', 'b', 'c')
a b c
1.000063419342041

Installation

You can install sloth with pip:

pip install sloth-speedtest

Please see the docs for more info.

Links

Note that this library is unrelated and mutually exclusive to the one that can be found at https://sloth.readthedocs.io