aAdd function set_api_url to set the Carbone API URL (On-Premise)

Author: dgrelaud

CHANGELOG.md

@@ -1,3 +1,6 @@
+### v1.0.8
+  - Add function `set_api_url` to set the Carbone API URL
+
 ### v1.0.7
   - Fix install script  https://github.com/carboneio/carbone-sdk-python/issues/7
   - Add function `get_status` to get the Carbone API status

README.md

@@ -29,8 +29,10 @@ import carbone_sdk
 # The access token can be passed as an argument to the constructor CarboneSDK
 # Or by the environment variable "CARBONE_TOKEN", use the command "export CARBONE_TOKEN=secret-token"
 csdk = carbone_sdk.CarboneSDK("secret-token")
-# Set API version
+# Set API version (default : 4)
 csdk.set_api_version("4")
+# Set API URL for Carbone On-Premise for example (default: "https://api.carbone.io")
+csdk.set_api_url("https://api.carbone.io")
 
 # The template ID, it could be an ODT, DOCX, PPTX, XLSX, ODS file, etc...
 template_id = "template"

carbone_sdk/carbone_sdk.py

@@ -77,6 +77,14 @@ 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_api_url(self, api_url = None):
+    if api_url is None:
+      raise ValueError('Carbone SDK set_api_url error: argument is missing: api_url')
+    if isinstance(api_url, str):
+      self._api_url = api_url
+    else:
+      raise ValueError('Carbone SDK set_api_url error: an argument is invalid: api_url is not a string')
+
   def render(self, file_or_template_id = None, json_data = None, payload = ""):
     if file_or_template_id is None:
       raise ValueError('Carbone SDK render error: argument is missing: file_or_template_id')

setup.py

@@ -5,7 +5,7 @@
 
 setuptools.setup(
     name="carbone-sdk",
-    version="1.0.7",
+    version="1.0.8",
     author="CarboneIO",
     author_email="support@carbone.io",
     description="Carbone API Python SDK to generate documents (PDF, docx, xlsx, ods, odt, ...) from a JSON and a template.",

tests/test_carbone_sdk.py

@@ -54,6 +54,16 @@ def test_set_api_version_error_missing_version(self, csdk):
       csdk.set_api_version()
     assert e.value.args[0] == 'Carbone SDK set_api_version error: argument is missing: api_version'
 
+  def test_set_api_url_error_missing_url(self, csdk):
+    with pytest.raises(ValueError) as e:
+      csdk.set_api_url()
+    assert e.value.args[0] == 'Carbone SDK set_api_url error: argument is missing: api_url'
+
+  def test_set_api_url(self, csdk):
+    new_url = "http://localhost:3000"
+    csdk.set_api_url(new_url)
+    assert csdk._api_url == "http://localhost:3000"
+
 class TestRender:
   def test_render_a_report_error_file_missing(self, csdk):
     with pytest.raises(ValueError) as e: