Loop-rate-limiters

This is version 1.0.0 of the project, whose API has reached a mature state. This release adds documentation and support for Python 3.11.

Added

- Documentation
- Support Python 3.11

Fixed

- RateLimiter: Initialization of slack attribute

This update adds a `dt` attribute to `AsyncRateLimiter`, matching its API better with that of the other `RateLimiter`.

Added

- AsyncRateLimiter: `dt` property

Changed

- AsyncRateLimiter: `measured_period` is now a property
- AsyncRateLimiter: `next_tick` is now a property
- AsyncRateLimiter: `period` is now a property
- AsyncRateLimiter: `slack` is now a property

This minor update adds a ``warn`` keyword argument to the rate limiter constructors. The default behavior is ``warn=True`` as before. Setting ``warn=False`` disables the "clock tick exceeded" warnings. It can be used for instance in applications that are not time critical.

Added

- AsyncRateLimiter: ``warn`` constructor argument
- RateLimiter: ``warn`` constructor argument

This minor release updates the synchronous ``RateLimiter`` so that it warns when it is running late, similarly to the asynchronous limiter.

Added

- RateLimiter: warn when the limiter is running late

This release turns rate limiter internals into read-only properties and adds the ``RateLimiter.dt`` shorthand for convenience. It also introduces installation from conda-forge as a (good) alternative to PyPI.

Added

- Installation from conda-forge
- RateLimiter: ``dt`` property
- RateLimiter: ``next_tick`` property

Changed

- Attributes are now read-only
- RateLimiter: ``period`` becomes read-only
- RateLimiter: ``slack`` becomes read-only