Metadata-Version: 2.1
Name: loop-rate-limiters
Version: 0.1.1
Summary: Loop rate limiters.
Keywords: rate,loop,frequency,regulator,limiter
Author-email: Stéphane Caron <stephane.caron@normalesup.org>
Maintainer-email: Stéphane Caron <stephane.caron@normalesup.org>
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering :: Mathematics
Project-URL: Changelog, https://github.com/stephane-caron/loop-rate-limiters/blob/master/CHANGELOG.md
Project-URL: Source, https://github.com/stephane-caron/loop-rate-limiters
Project-URL: Tracker, https://github.com/stephane-caron/loop-rate-limiters/issues

# Loop rate limiters

[![Build](https://img.shields.io/github/workflow/status/stephane-caron/loop-rate-limiters/CI)](https://github.com/stephane-caron/loop-rate-limier/actions)
[![Coverage](https://coveralls.io/repos/github/stephane-caron/loop-rate-limiters/badge.svg?branch=main)](https://coveralls.io/github/stephane-caron/loop-rate-limiters?branch=main)
[![PyPI version](https://img.shields.io/pypi/v/loop-rate-limiters)](https://pypi.org/project/loop-rate-limiters/)

Simple loop frequency regulators in Python with an API similar to [``rospy.Rate``](https://wiki.ros.org/rospy/Overview/Time#Sleeping_and_Rates).

## Installation

```sh
pip install loop-rate-limiters
```

## Usage

The ``RateLimiter`` class provides a loop frequency limiter:

```python
from loop_rate_limiters import RateLimiter
from time import perf_counter

rate = RateLimiter(frequency=400.0)
while True:
    print(f"Hello from loop at {perf_counter():.3f} s")
    rate.sleep()
```

