Allow to configure the base domain (defaults to armis.com)

Author: shaiarmis

armis_sdk/core/armis_client.py

@@ -13,12 +13,14 @@
 from armis_sdk.core import response_utils
 from armis_sdk.core.armis_auth import ArmisAuth
 
+ARMIS_BASE_DOMAIN = "ARMIS_BASE_DOMAIN"
+ARMIS_CLIENT_ID = "ARMIS_CLIENT_ID"
 ARMIS_PAGE_SIZE = "ARMIS_PAGE_SIZE"
 ARMIS_REQUEST_RETRIES = "ARMIS_REQUEST_RETRIES"
 ARMIS_SECRET_KEY = "ARMIS_SECRET_KEY"
 ARMIS_TENANT = "ARMIS_TENANT"
-ARMIS_CLIENT_ID = "ARMIS_CLIENT_ID"
-BASE_URL = "https://{tenant}.armis.com"
+BASE_DOMAIN = "armis.com"
+BASE_URL = "https://{tenant}.{base_domain}"
 DEFAULT_PAGE_LENGTH = 1000
 try:
     VERSION = importlib.metadata.version("armis_sdk")
@@ -48,10 +50,12 @@ def __init__(
         tenant: Optional[str] = None,
         secret_key: Optional[str] = None,
         client_id: Optional[str] = None,
+        base_domain: Optional[str] = BASE_DOMAIN,
     ):
         tenant = os.getenv(ARMIS_TENANT, tenant)
         secret_key = os.getenv(ARMIS_SECRET_KEY, secret_key)
         client_id = os.getenv(ARMIS_CLIENT_ID, client_id)
+        base_domain = os.getenv(ARMIS_BASE_DOMAIN, base_domain)
 
         if not tenant:
             raise ValueError(
@@ -69,7 +73,7 @@ def __init__(
                 f"or pass an explicit value to the constructor"
             )
 
-        self._base_url = BASE_URL.format(tenant=tenant)
+        self._base_url = BASE_URL.format(tenant=tenant, base_domain=base_domain)
         self._auth = ArmisAuth(self._base_url, secret_key)
         self._user_agent = " ".join(USER_AGENT_PARTS)
         self._client_id = client_id

armis_sdk/core/armis_sdk.py

@@ -2,6 +2,7 @@
 
 from armis_sdk.clients.sites_client import SitesClient
 from armis_sdk.core.armis_client import ArmisClient
+from armis_sdk.core import armis_client
 
 ARMIS_SECRET_KEY = "ARMIS_SECRET_KEY"
 ARMIS_TENANT = "ARMIS_TENANT"
@@ -39,8 +40,12 @@ def __init__(
         tenant: Optional[str] = None,
         secret_key: Optional[str] = None,
         client_id: Optional[str] = None,
+        base_domain: Optional[str] = armis_client.BASE_DOMAIN,
     ):
         self.client = ArmisClient(
-            tenant=tenant, client_id=client_id, secret_key=secret_key
+            tenant=tenant,
+            client_id=client_id,
+            secret_key=secret_key,
+            base_domain=base_domain,
         )
         self.sites = SitesClient(self.client)

docs/index.md

@@ -9,13 +9,14 @@ pip install armis_sdk
 ```
 ## Usage
 
-All interaction with the SDK happens through the [ArmisSdk][armis_sdk.core.armis_sdk.ArmisSdk] class. You'll need 3 things:
+All interaction with the SDK happens through the [ArmisSdk][armis_sdk.core.armis_sdk.ArmisSdk] class. You'll need a few things:
 
 1. **Tenant name**: The name of the tenant you want to interact with.
 2. **Secret key**: The secret key associated with the tenant, obtained from the tenant itself.
 3. **Client id**: A unique identifier for you application. Currently, this can be any string.
+4. **(optional) Base domain**: The base domain of you tenant, defaults to `armis.com`,
 
-You can either provide these values using the environment variables `ARMIS_TENANT`, `ARMIS_SECRET_KEY`, and `ARMIS_CLIENT_ID`:
+You can either provide these values using the environment variables `ARMIS_TENANT`, `ARMIS_SECRET_KEY`, `ARMIS_CLIENT_ID`, and `ARMIS_BASE_DOMAIN`:
 ```python linenums="1"
 from armis_sdk import ArmisSdk
 
@@ -26,7 +27,7 @@ or by passing them explicitly:
 ```python linenums="1"
 from armis_sdk import ArmisSdk
 
-armis_sdk = ArmisSdk(tenant="<tenant>", secret_key="<secret_key>", client_id="<client_id>")
+armis_sdk = ArmisSdk(tenant="<tenant>", secret_key="<secret_key>", client_id="<client_id>", base_domain="<base_domain>")
 ```
 !!!tip