Added function set_timeout

Author: steevepay

.gitignore

@@ -144,4 +144,6 @@ dmypy.json
 
 # End of https://www.gitignore.io/api/code,macos,python
 
-*.tmp.*
+*.tmp.*
+
+env

API-REFERENCE.md

@@ -235,6 +235,23 @@ except Exception as err:
   print("Something went wrong: {0}".format(err))
 ```
 
+---
+### set_timeout
+
+Configures the HTTP client timeout for requests made to the Carbone server. The default timeout value is set to 60 seconds, which matches the Carbone Cloud server's default timeout.
+
+If you are generating documents using a Carbone On-Premise server with a custom timeout configuration, you may need to adjust the timeout value accordingly. Increase the timeout value to ensure that the HTTP client waits long enough for the server to process the request.
+
+```python
+import carbone_sdk
+
+csdk = carbone_sdk.CarboneSDK("your_access_token")
+
+csdk.set_timeout(120) # = 2 minutes
+csdk.set_timeout(300) # = 5 minutes
+```
+
+---
 ### get_status
 
 **Definition**

CHANGELOG.md

@@ -1,3 +1,6 @@
+### v1.1.1
+  - Added function `set_timeout`: Configures the HTTP client timeout for requests made to the Carbone server.
+
 ### v1.1.0
   - Fixed: Added "requests" as required install.
   - Update to Carbone version 5

carbone_sdk/carbone_sdk.py

@@ -77,6 +77,13 @@ def set_api_version(self, api_version = None):
     else:
       raise ValueError('Carbone SDK set_api_version error: an argument is invalid: api_version is not a number nor a string')
 
+  def set_timeout(self, api_timeout = None):
+    if api_timeout is None:
+      raise ValueError('Carbone SDK set_timeout error: argument is missing: api_timeout')
+    elif not isinstance(api_timeout, int):
+      raise ValueError('Carbone SDK set_timeout error: argument is not a number')
+    self._api_timeout = api_timeout
+
   def set_api_url(self, api_url = None):
     if api_url is None:
       raise ValueError('Carbone SDK set_api_url error: argument is missing: api_url')

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="carbone-sdk",
-    version="1.1.0",
+    version="1.1.1",
     author="CarboneIO",
     author_email="support@carbone.io",
     description="Carbone API Python SDK to generate documents (PDF DOCX XLSX PPTX CSV XML HTML ODS ODT and more) from a JSON and a template.",
@@ -15,8 +15,10 @@
     packages=setuptools.find_packages(),
     classifiers=[
         "Programming Language :: Python :: 3",
-        "License :: OSI Approved :: Apache Software License",
         "Operating System :: OS Independent",
+        "Intended Audience :: Developers",
+        "Development Status :: 5 - Production/Stable",
+        "Topic :: Software Development :: Libraries :: Python Modules"
     ],
     python_requires='>=3.6',
     license='Apache-2.0',

tests/test_carbone_sdk.py

@@ -15,7 +15,8 @@ def csdk():
 class TestInitSDK:
   def test_sdk_default_values(self, csdk):
     assert csdk._api_headers["Authorization"] == "Bearer Token"
-    assert csdk._api_headers["carbone-version"] == "4"
+    assert csdk._api_headers["carbone-version"] == "5"
+    assert csdk._api_timeout == 60
     assert csdk._api_url == "https://api.carbone.io"
 
   def test_init_sdk_error_missing_token(self):
@@ -39,6 +40,23 @@ def test_set_access_token_error_missing_token(self, csdk):
       csdk.set_access_token()
     assert e.value.args[0] == 'Carbone SDK set_access_token error: argument is missing: api_token'
 
+  def test_set_timeout_int(self, csdk):
+    default_timeout = csdk._api_timeout
+    new_timeout = 85000
+    csdk.set_timeout(new_timeout)
+    assert csdk._api_timeout == new_timeout
+    csdk.set_timeout(default_timeout)
+
+  def test_set_timeout_string(self, csdk):
+    with pytest.raises(ValueError) as e:
+      csdk.set_timeout("123123144")
+    assert e.value.args[0] == 'Carbone SDK set_timeout error: argument is not a number'
+  
+  def test_set_timeout_missing(self, csdk):
+    with pytest.raises(ValueError) as e:
+      csdk.set_timeout()
+    assert e.value.args[0] == 'Carbone SDK set_timeout error: argument is missing: api_timeout'
+
   def test_set_api_version_int(self, csdk):
     new_version = 2
     csdk.set_api_version(new_version)