Document rate limit tracking functionality in README

Open Copilot opened this issue 5 months ago • 0 comments

PR #55 added rate limit tracking via the irRateLimit class but left it undocumented.

Changes

New section: "Accessing Rate Limit Information" with usage example
Updated changelog: Added rate limit tracking to version 1.3.0 entry

Usage

from iracingdataapi.client import irDataClient

idc = irDataClient(username=user, password=pwd)
idc.get_cars()

if idc.rate_limit.has_data:
    print(f"Remaining: {idc.rate_limit.remaining}/{idc.rate_limit.limit}")
    print(f"Resets in: {idc.rate_limit.seconds_until_reset}s")

The rate_limit property exposes: limit, remaining, reset, reset_time, seconds_until_reset, is_rate_limited, and has_data.

Original prompt

Update the readme with any changes that haven't been documented.

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Nov 14 '25 11:11 Copilot