Skip to content

Commit e407a97

Browse files
docs: UpdateReadme
1 parent 04e3034 commit e407a97

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,12 @@ poetry add api-to-dataframe
5151
## Importing library
5252
from api_to_dataframe import ClientBuilder, RetryStrategies
5353

54-
# Create a client for the API without retry strategy
55-
client = ClientBuilder(endpoint="https://api.example.com", retry_strategy=RetryStrategies.NoRetryStrategy)
54+
# Create a client for the API without retry strategy and default timeout (5 seconds)
55+
client = ClientBuilder(endpoint="https://api.example.com")
5656
# or with LinearStrategy (In development, actually don't nothing)
5757
client = ClientBuilder(endpoint="https://api.example.com", retry_strategy=RetryStrategies.LinearStrategy)
58+
# if you can define timeout, use: (default is 5 seconds)
59+
client = ClientBuilder(endpoint="https://api.example.com", retry_strategy=RetryStrategies.LinearStrategy, timeout=10)
5860

5961
# Get data from the API
6062
data = client.get_api_data()

0 commit comments

Comments
 (0)