Metadata-Version: 2.1
Name: timeoutcall
Version: 1.0rc2
Summary: A package designed to kill a function after a specified amount of time.
Home-page: https://github.com/xyzpw/timeoutcall/
Author: xyzpw
Maintainer: xyzpw
License: MIT
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Intended Audience :: Developers
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# timeoutcall
A package designed to kill a function after a specified amount of time.

## Usage
Killing a function after a specified amount of time:
```python
from timeoutcall import timeout
from time import sleep

@timeout(2, "error: took too long")
def foo():
    sleep(3) # will raise TimeoutError

foo()
```
Running a test/preview:
```bash
$ python3 -m timeoutcall.test
```

## Developers
### Build and Source Distributions
To build the wheel and source distributions, cd into the repositories root directory and run the following command:
```bash
python3 -m build
```
