api-to-dataframe 1.2.1__tar.gz → 1.2.3__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,13 +1,12 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: api-to-dataframe
3
- Version: 1.2.1
3
+ Version: 1.2.3
4
4
  Summary: A package to convert API responses to pandas dataframe
5
- Home-page: https://github.com/IvanildoBarauna/api-to-dataframe
6
5
  License: MIT
7
6
  Author: IvanildoBarauna
8
7
  Author-email: ivanildo.jnr@outlook.com
9
8
  Requires-Python: >=3.9,<4.0
10
- Classifier: Development Status :: 3 - Alpha
9
+ Classifier: Development Status :: 4 - Beta
11
10
  Classifier: Intended Audience :: Developers
12
11
  Classifier: License :: OSI Approved :: MIT License
13
12
  Classifier: Programming Language :: Python :: 3
@@ -18,13 +17,16 @@ Classifier: Programming Language :: Python :: 3.12
18
17
  Classifier: Programming Language :: Python :: 3.8
19
18
  Requires-Dist: pandas (>=2.2.2,<3.0.0)
20
19
  Requires-Dist: requests (>=2.32.3,<3.0.0)
21
- Project-URL: Documentation, https://github.com/IvanildoBarauna/api-to-dataframe#readme
20
+ Project-URL: Documentation, https://github.com/IvanildoBarauna/api-to-dataframe/blob/main/README.md
21
+ Project-URL: Homepage, https://pypi.org/project/api-to-dataframe
22
+ Project-URL: ImplementationCase, https://github.com/IvanildoBarauna/ETL-awesome-api
22
23
  Project-URL: Issues, https://github.com/IvanildoBarauna/api-to-dataframe/issues
24
+ Project-URL: Notebook, https://github.com/IvanildoBarauna/api-to-dataframe/blob/main/notebooks/example.ipynb
23
25
  Project-URL: Repository, https://github.com/IvanildoBarauna/api-to-dataframe
24
26
  Description-Content-Type: text/markdown
25
27
 
26
28
  # API to DataFrame
27
- Your solution to convert API responses to Pandas DataFrames with retry strategies and detailed reports.
29
+ Python library that simplifies obtaining data from API endpoints by converting them directly into Pandas DataFrames. This library offers robust features, including retry strategies for failed requests.
28
30
 
29
31
  [![Github](https://img.shields.io/badge/-Go_to_Github_repository-05122A?style=flat&logo=github)](https://github.com/IvanildoBarauna/api-to-dataframe)
30
32
 
@@ -51,11 +53,6 @@ Your solution to convert API responses to Pandas DataFrames with retry strategie
51
53
  ![pytest](https://img.shields.io/badge/-pytest-05122A?style=flat&logo=pytest)&nbsp;
52
54
 
53
55
 
54
-
55
- ## Library Description
56
-
57
- Python library that simplifies obtaining data from API endpoints by converting them directly into Pandas DataFrames. This library offers robust features, including retry strategies for failed requests and automatic generation of detailed reports on the received data.
58
-
59
56
  ## Installation
60
57
 
61
58
  To install the package using pip, use the following command:
@@ -98,7 +95,7 @@ client = ClientBuilder(endpoint="https://api.example.com"
98
95
  ,connection_timeout=10
99
96
  ,headers=headers
100
97
  ,retries=5
101
- ,delay=10)
98
+ ,initial_delay=10)
102
99
 
103
100
 
104
101
  ### timeout, retry_strategy and headers are opcionals parameters
@@ -1,5 +1,5 @@
1
1
  # API to DataFrame
2
- Your solution to convert API responses to Pandas DataFrames with retry strategies and detailed reports.
2
+ Python library that simplifies obtaining data from API endpoints by converting them directly into Pandas DataFrames. This library offers robust features, including retry strategies for failed requests.
3
3
 
4
4
  [![Github](https://img.shields.io/badge/-Go_to_Github_repository-05122A?style=flat&logo=github)](https://github.com/IvanildoBarauna/api-to-dataframe)
5
5
 
@@ -26,11 +26,6 @@ Your solution to convert API responses to Pandas DataFrames with retry strategie
26
26
  ![pytest](https://img.shields.io/badge/-pytest-05122A?style=flat&logo=pytest)&nbsp;
27
27
 
28
28
 
29
-
30
- ## Library Description
31
-
32
- Python library that simplifies obtaining data from API endpoints by converting them directly into Pandas DataFrames. This library offers robust features, including retry strategies for failed requests and automatic generation of detailed reports on the received data.
33
-
34
29
  ## Installation
35
30
 
36
31
  To install the package using pip, use the following command:
@@ -73,7 +68,7 @@ client = ClientBuilder(endpoint="https://api.example.com"
73
68
  ,connection_timeout=10
74
69
  ,headers=headers
75
70
  ,retries=5
76
- ,delay=10)
71
+ ,initial_delay=10)
77
72
 
78
73
 
79
74
  ### timeout, retry_strategy and headers are opcionals parameters
@@ -1,26 +1,26 @@
1
1
  [tool.poetry]
2
2
  name = "api-to-dataframe"
3
- version = "1.2.1"
3
+ version = "1.2.3"
4
4
  description = "A package to convert API responses to pandas dataframe"
5
5
  authors = ["IvanildoBarauna <ivanildo.jnr@outlook.com>"]
6
6
  readme = "README.md"
7
7
  license = "MIT"
8
8
  classifiers=[
9
- "Development Status :: 3 - Alpha",
9
+ "Development Status :: 4 - Beta",
10
10
  "Intended Audience :: Developers",
11
11
  "License :: OSI Approved :: MIT License",
12
12
  "Programming Language :: Python :: 3",
13
13
  "Programming Language :: Python :: 3.8",
14
14
  ]
15
15
 
16
- homepage = "https://github.com/IvanildoBarauna/api-to-dataframe"
17
- repository = "https://github.com/IvanildoBarauna/api-to-dataframe"
18
- documentation = "https://github.com/IvanildoBarauna/api-to-dataframe#readme"
19
16
 
20
17
  [tool.poetry.urls]
21
- Homepage = "https://github.com/IvanildoBarauna/api-to-dataframe"
22
- Documentation = "https://github.com/IvanildoBarauna/api-to-dataframe#readme"
18
+ Homepage = "https://pypi.org/project/api-to-dataframe"
19
+ Documentation = "https://github.com/IvanildoBarauna/api-to-dataframe/blob/main/README.md"
20
+ Notebook = 'https://github.com/IvanildoBarauna/api-to-dataframe/blob/main/notebooks/example.ipynb'
21
+ ImplementationCase = 'https://github.com/IvanildoBarauna/ETL-awesome-api'
23
22
  Issues = "https://github.com/IvanildoBarauna/api-to-dataframe/issues"
23
+ Repository = "https://github.com/IvanildoBarauna/api-to-dataframe"
24
24
 
25
25
  [tool.poetry.dependencies]
26
26
  python = "^3.9"
@@ -1,5 +1,4 @@
1
- from api_to_dataframe.models.retainer import RetryStrategies
2
- from api_to_dataframe.models.retainer import Strategies
1
+ from api_to_dataframe.models.retainer import RetryStrategies, Strategies
3
2
  from api_to_dataframe.models.get_data import GetData
4
3
 
5
4
 
@@ -9,7 +8,7 @@ class ClientBuilder:
9
8
  headers: dict = None,
10
9
  retry_strategy: Strategies = Strategies.NoRetryStrategy,
11
10
  retries: int = 3,
12
- delay: int = 1,
11
+ initial_delay: int = 1,
13
12
  connection_timeout: int = 1):
14
13
 
15
14
  """
@@ -36,7 +35,7 @@ class ClientBuilder:
36
35
  raise ValueError("::: endpoint param is mandatory :::")
37
36
  if not isinstance(retries, int) or retries < 0:
38
37
  raise ValueError("retries must be a non-negative integer")
39
- if not isinstance(delay, int) or delay < 0:
38
+ if not isinstance(initial_delay, int) or initial_delay < 0:
40
39
  raise ValueError("delay must be a non-negative integer")
41
40
  if not isinstance(connection_timeout, int) or connection_timeout < 0:
42
41
  raise ValueError("connection_timeout must be a non-negative integer")
@@ -46,7 +45,7 @@ class ClientBuilder:
46
45
  self.connection_timeout = connection_timeout
47
46
  self.headers = headers
48
47
  self.retries = retries
49
- self.delay = delay
48
+ self.delay = initial_delay
50
49
 
51
50
  @RetryStrategies
52
51
  def get_api_data(self):