Metadata-Version: 2.1
Name: sloth-speedtest
Version: 0.2.post1
Summary: The best python speedtesting library and command line tool
Home-page: https://github.com/fluffykoalas/sloth
Author: Legorooj
Author-email: legorooj@protonmail.com
Maintainer: Legorooj, FluffyKoalas
License: MIT
Project-URL: Bug Tracker, https://github.com/fluffykoalas/sloth/issues
Project-URL: Documentation, https://sloth.fluffykoalas.org/en/stable
Project-URL: Source Code, https://github.com/fluffykoalas/sloth
Description: # `sloth`
        
        #### *The* python speedtesting library and command line tool
        
        [![codecov](https://codecov.io/gh/fluffykoalas/sloth/branch/dev/graph/badge.svg)](https://codecov.io/gh/fluffykoalas/sloth)
        [![Build Status](https://dev.azure.com/FluffyKoalas/Sloth/_apis/build/status/fluffykoalas.sloth?branchName=dev)](https://dev.azure.com/FluffyKoalas/Sloth/_build/latest?definitionId=2&branchName=dev)
        [![Codacy Badge](https://api.codacy.com/project/badge/Grade/3f46b1c00c674ce4b614be082c17ef5b)](https://www.codacy.com/gh/fluffykoalas/sloth?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=fluffykoalas/sloth&amp;utm_campaign=Badge_Grade)
        [![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://choosealicense.com/licenses/mit/)
        [![Contributors](https://img.shields.io/github/contributors/fluffykoalas/sloth.svg)](https://github.com/fluffykoalas/sloth/pulse)
        [![Last Commit](https://img.shields.io/github/last-commit/fluffykoalas/sloth.svg)](https://github.com/fluffykoalas/sloth/commits)
        [![Documentation Status](https://readthedocs.org/projects/sloth-speedtest/badge/?version=latest)](https://sloth.fluffykoalas.org/en/latest/?badge=latest)
        
        `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:
        
        ```python
        >>> 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
        
        ```python
        >>> 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
        
        * [PyPI](https://pypi.org/project/sloth-speedtest)
        * [Documentation](https://sloth.fluffykoalas.org)
        
        
        Note that this library is unrelated and mutually exclusive to 
        the one at https://sloth.readthedocs.io
        
Keywords: python speed speedtesting testing speedtest awesome cli sloth
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Testing
Requires-Python: >=3.5
Description-Content-Type: text/markdown
