Merge pull request #50 from IvanildoBarauna/feat-StableVersiion

feat-StableVersion

Author: IvanildoBarauna

.github/workflows/CI.yaml

@@ -30,7 +30,7 @@ jobs:
           poetry install
 
       - name: Run tests & CodeCov
-        run: |          
+        run: |
           coverage run -m pytest
           coverage report
           coverage xml

.idea/misc.xml

@@ -1,12 +1,32 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v3.4.0
-    hooks: []
+    rev: v4.6.0
+    hooks:
+      - id: check-yaml
+      - id: trailing-whitespace
+
+  - repo: https://github.com/psf/black
+    rev: 23.3.0
+    hooks:
+      - id: black
+
+  - repo: local
+    hooks:
+      - id: pylint
+        name: pylint
+        entry: pylint
+        language: system
+        types: [python]
+        args:
+          [
+            "-rn", # Only display messages
+            "--disable=C0114,C0115,C0116, R0903",
+          ]
 
 #  - repo: local
 #    hooks:
-#      - id: version-increment
-#        name: version-increment
+#      - id: version-inc
+#        name: Version Increase
 #        entry: ./version_increment.sh
 #        language: script
-#        always_run: true
+#        files: .*

.pre-commit-config.yaml

@@ -19,7 +19,7 @@ Python library that simplifies obtaining data from API endpoints by converting t
 ![Python](https://img.shields.io/badge/-Python-05122A?style=flat&logo=python) 
 ![Docker](https://img.shields.io/badge/-Docker-05122A?style=flat&logo=docker) 
 ![Poetry](https://img.shields.io/badge/-Poetry-05122A?style=flat&logo=poetry) 
-![GitHub Actions](https://img.shields.io/badge/-GitHub_Actions-05122A?style=flat&logo=githubactions)  
+![GitHub Actions](https://img.shields.io/badge/-GitHub_Actions-05122A?style=flat&logo=githubactions) 
 ![CodeCov](https://img.shields.io/badge/-CodeCov-05122A?style=flat&logo=codecov) 
 ![pypi](https://img.shields.io/badge/-pypi-05122A?style=flat&logo=pypi) 
 ![pandas](https://img.shields.io/badge/-pandas-05122A?style=flat&logo=pandas) 
@@ -49,29 +49,28 @@ from api_to_dataframe import ClientBuilder, RetryStrategies
 # Create a client for simple ingest data from API (timeout 1 second)
 client = ClientBuilder(endpoint="https://api.example.com")
 
-# if you can define timeout with LinearStrategy and set headers:
+# if you can define timeout with LINEAR_RETRY_STRATEGY and set headers:
 headers = {
     "application_name": "api_to_dataframe"
 }
 client = ClientBuilder(endpoint="https://api.example.com"
-                        ,retry_strategy=RetryStrategies.LinearStrategy
+                        ,retry_strategy=RetryStrategies.LINEAR_RETRY_STRATEGY
                         ,connection_timeout=2
                         ,headers=headers)
 
 """
-    NOTE: by default the quantity of retries is 3 and the time between retries is 1 second, but you can define manually, like this:
-    
+NOTE: by default the quantity of retries is 3 and the time between retries is 1 second, but you can define manually.
 """
 
 client = ClientBuilder(endpoint="https://api.example.com"
-                        ,retry_strategy=RetryStrategies.LinearStrategy
+                        ,retry_strategy=RetryStrategies.LINEAR_RETRY_STRATEGY
                         ,connection_timeout=10
                         ,headers=headers
                         ,retries=5
                         ,initial_delay=10)
- 
 
-### timeout, retry_strategy and headers are opcionals parameters 
+
+### timeout, retry_strategy and headers are opcionals parameters
 
 # Get data from the API
 data = client.get_api_data()