Metadata-Version: 2.1
Name: execspeed
Version: 0.0.3
Summary: Simple tool for finding average function execution time
Home-page: https://github.com/Astrochamp/speed
Author: Ivan O'Connor
Author-email: ivanoconnor@hotmail.co.uk
License: UNKNOWN
Project-URL: Bug Tracker, https://github.com/Astrochamp/speed/issues
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# PyExecSpeed

A simple package for calculating the execution time of a function in a Python file

## Usage:

`checkSpeed(function, r)`
where `function` is any function from your Python file and `r` is the number of times to run it. The average execution time is returned rather than printed.

## Example:
```py
from speed import checkSpeed

def myFunc():
  x = 2
  for i in range(100):
    x *= i
  print(x)

n = 10
print(checkSpeed(myFunc, n)) # Repeats myFunc n (= 10) times and returns the average execution time. 
# A higher value of n will likely result in a more accurate value, but will take longer.


>>> 0.00003339
```

### Notes:

* The output is a string, not a float. This is to prevent Python from returning a result in scientific notation.
* While `checkSpeed()` runs a function, it blocks printing within that function so the terminal isn't filled with potentially hundreds of prints
* Currently, passing arguments into the `function` argument e.g. `checkSpeed(myFunc(a,b), 100)` **doesn't** work. I'll add this soon, with the syntax: `checkSpeed(function, r, <other>, <arguments>, <here>...)`, which will check the execution time of `function(other, arguments, here...)`


### [Create an issue](https://github.com/Astrochamp/speed/issues) if you have any feedback / bugs you want to report

