Skip to content

Commit 0df8389

Browse files
docs: adjusts README examples
1 parent 0320bcf commit 0df8389

File tree

2 files changed

+15
-15
lines changed

2 files changed

+15
-15
lines changed

README.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ client = ClientBuilder(endpoint="https://api.example.com"
6565
,headers=headers
6666
,retries=5
6767
,initial_delay=10)
68-
68+
6969

7070
# Get data from the API
7171
data = client.get_api_data()
@@ -81,22 +81,22 @@ print(df)
8181
* **Opcionals Parameters:** The params timeout, retry_strategy and headers are opcionals.
8282
* **Default Params Value:** By default the quantity of retries is 3 and the time between retries is 1 second, but you can define manually.
8383
* **Max Of Retries:** For security of API Server there is a limit for quantity of retries, actually this value is 5, this value is defined in lib constant. You can inform any value in RETRIES param, but the lib only will try 5x.
84-
* **Exponential Retry Strategy:** The increment of time between retries is time passed in **initial_delay** param * 2 * the retry_number, e.g with initial_delay=1
84+
* **Exponential Retry Strategy:** The increment of time between retries is time passed in **initial_delay** param * 2 * the retry_number, e.g with initial_delay=2
8585

86-
RetryNumber | WaitingTime
86+
RetryNumber | WaitingTime
8787
------------ | -----------
88-
1 | 1s
8988
2 | 2s
90-
3 | 4s
91-
4 | 6s
92-
5 | 8s
89+
2 | 4s
90+
3 | 6s
91+
4 | 8s
92+
5 | 10s
9393
* **Linear Retry Strategy:** The increment of time between retries is time passed in **initial_delay**
94-
e.g with initial_delay=1
94+
e.g with initial_delay=2
9595

96-
RetryNumber | WaitingTime
96+
RetryNumber | WaitingTime
9797
------------ | -----------
98-
1 | 1s
99-
2 | 1s
100-
3 | 1s
101-
4 | 1s
102-
5 | 1s
98+
1 | 2s
99+
2 | 2s
100+
3 | 2s
101+
4 | 2s
102+
5 | 2s

pyproject.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "api-to-dataframe"
3-
version = "1.3.8"
3+
version = "1.3.9"
44
description = "A package to convert API responses to pandas dataframe"
55
authors = ["IvanildoBarauna <[email protected]>"]
66
readme = "README.md"

0 commit comments

Comments
 (0)