diff options
| -rw-r--r-- | README.md | 12 |
1 files changed, 12 insertions, 0 deletions
| @@ -43,6 +43,18 @@ If using [Poetry](https://python-poetry.org/), all Python dependencies are fetch | |||
| 43 | | DAY_IN_NANO | 8.64 * (10 ** 13) | The amount of nanoseconds in 24 hours | | 43 | | DAY_IN_NANO | 8.64 * (10 ** 13) | The amount of nanoseconds in 24 hours | |
| 44 | | JSON_INDENT | 4 | The indent used when dumping a Python object to a .json file | | 44 | | JSON_INDENT | 4 | The indent used when dumping a Python object to a .json file | |
| 45 | 45 | ||
| 46 | ### `steamrelationships.sr.SteamRelationships()` parameters | ||
| 47 | |||
| 48 | | Parameter | Expected Value | Description | | ||
| 49 | | :-------: | :------------- | :---------- | | ||
| 50 | | webapikey | `str` **(REQUIRED)** | A [Steam Dev API Key](https://steamcommunity.com/dev/apikey) | | ||
| 51 | | timeout | `int` (Default: 30) | The number of seconds to wait for a response from Steam before timing out | | ||
| 52 | | timeout_retries | `int` (Default: 5) | The number of times to retry after a timeout | | ||
| 53 | | reqdelay | `float` (Default: 0.5) | The base number of seconds to wait between requests | | ||
| 54 | | delayrand | `int` (Default: 25) | The percentage up or down a delay may vary. *Clamped between 0 and 99, negative values made positive* | | ||
| 55 | | 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* | | ||
| 56 | | reqjson | `str` (Default: "requests.json") | Filepath to where the requests json file should be stored | | ||
| 57 | |||
| 46 | ### `steamrelationships.sr.SteamRelationships()` methods | 58 | ### `steamrelationships.sr.SteamRelationships()` methods |
| 47 | 59 | ||
| 48 | | Function | Params | Return Values | Description | | 60 | | Function | Params | Return Values | Description | |
