From 7d59a8c8c670b2da8560b19c9e0e755ee1453ac4 Mon Sep 17 00:00:00 2001 From: NW/RL Date: Sat, 13 Apr 2024 22:50:53 -0500 Subject: More documentation --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 6574f37..3dad3fe 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,18 @@ If using [Poetry](https://python-poetry.org/), all Python dependencies are fetch | DAY_IN_NANO | 8.64 * (10 ** 13) | The amount of nanoseconds in 24 hours | | JSON_INDENT | 4 | The indent used when dumping a Python object to a .json file | +### `steamrelationships.sr.SteamRelationships()` parameters + +| Parameter | Expected Value | Description | +| :-------: | :------------- | :---------- | +| webapikey | `str` **(REQUIRED)** | A [Steam Dev API Key](https://steamcommunity.com/dev/apikey) | +| timeout | `int` (Default: 30) | The number of seconds to wait for a response from Steam before timing out | +| timeout_retries | `int` (Default: 5) | The number of times to retry after a timeout | +| reqdelay | `float` (Default: 0.5) | The base number of seconds to wait between requests | +| delayrand | `int` (Default: 25) | The percentage up or down a delay may vary. *Clamped between 0 and 99, negative values made positive* | +| reqsafetybuffer | `float` (Default: 0.9) | A percentage of Steam's daily api request limit to stop at. *0.9 stops at 90% of the max* | +| reqjson | `str` (Default: "requests.json") | Filepath to where the requests json file should be stored | + ### `steamrelationships.sr.SteamRelationships()` methods | Function | Params | Return Values | Description | -- cgit v1.2.3