specify timeout per endpoint. no retry on read timeout.

Author: FaydSpeare

README.md

@@ -119,6 +119,31 @@ if __name__ == "__main__":
     asyncio.run(main())
 ```
 
+### Network Retries
+
+By default the `EDClient` will perform 3 retries when it encounters network issues. If you would like to customise this behaviour, you can pass in the `max_network_retries` param as show below:
+
+Note: if the request times out, it will not be retried.
+
+```python
+from ensembledata.api import EDClient
+
+client = EDClient("API-TOKEN", max_network_retries=5)
+```
+
+### Configure Timeout
+
+If you would like control over the read timeout, you can configure this either for all request by setting `timeout` when creating the `EDClient`, or you can specify the `timeout` per request, on any of the individual methods as shown below:
+
+Note: the timeout is specified in seconds.
+
+```python
+from ensembledata.api import EDClient
+
+client = EDClient("API-TOKEN", timeout=120)
+result = client.tiktok.user_info_from_username(username="daviddobrik", timeout=10)
+```
+
 ### Types
 
 The package uses type hints, and is type checked with the latest version of `mypy`. If you experience any type checking related issues with the package, please let us know by creating an issue.

codegen/templates/client.jinja

@@ -36,6 +36,7 @@ class {{ key }}Endpoints:
         {% endif %}
         {% endfor %}        
         extra_params: Mapping[str, Any] | None = None,
+        timeout: float | None = None,
     ) -> EDResponse:
         params: dict[str, Any] = {
         {% for item in x.params %}
@@ -49,14 +50,14 @@ class {{ key }}Endpoints:
         if extra_params is not None:
             params = {**extra_params, **params}
         params = {k: v for k, v in params.items() if not (v is None or v is USE_DEFAULT)}
-        return {{ "await " if async_methods else "" }}self.requester.get("{{ x.path }}", params=params{{ ", return_top_level_data=True" if x.return_top_level_data else "" }}) 
+        return {{ "await " if async_methods else "" }}self.requester.get("{{ x.path }}", params=params, timeout=timeout{{ ", return_top_level_data=True" if x.return_top_level_data else "" }}) 
 
     {% endfor %}
 
 {% endfor %}
 
 class ED{{ "Async" if async_methods else "" }}Client:
-    def __init__(self, token: str, *, timeout: int = 600, max_network_retries: int = 3):
+    def __init__(self, token: str, *, timeout: float = 600, max_network_retries: int = 3):
         self.requester = {{ "Async" if async_methods else "" }}Requester(
             token, timeout=timeout, max_network_retries=max_network_retries
         )
@@ -65,4 +66,4 @@ class ED{{ "Async" if async_methods else "" }}Client:
         {% endfor %}
 
     async def request(self, uri: str, params: Mapping[str, Any] | None = None) -> EDResponse:
-        return {{ "await " if async_methods else "" }}self.requester.get(uri, params=params or {})
+        return {{ "await " if async_methods else "" }}self.requester.get(uri, params=params or {})