Replace base_url with api_url in the client constructor (#53)

On the platform, we have only the API server URL without the version suffix available as environment variables in the actor,
so you can't supply them directly to the client. This splits it so that users can supply just the API url to the client constructor,
and the API version suffix gets appended internally (the utilized API version is an internal thing of this client,
it shouldn't be passed from the outside in the first place).

Author: fnesveda

CHANGELOG.md

@@ -1,6 +1,14 @@
 Changelog
 =========
 
+[0.2.0](../../releases/tag/v0.2.0) - 2021-08-09
+-----------------------------------------------
+
+### Changed
+
+- replaced `base_url` with `api_url` in the client constructor
+  to enable easier passing of the API server url from environment variables availabl to actors on the Apify platform
+
 [0.1.0](../../releases/tag/v0.1.0) - 2021-08-02
 -----------------------------------------------
 

docs/docs.md

@@ -167,15 +167,15 @@ The Apify API client.
 
 ***
 
-#### [](#apifyclient-__init__) `ApifyClient.__init__(token=None, *, base_url='https://api.apify.com/v2', max_retries=8, min_delay_between_retries_millis=500)`
+#### [](#apifyclient-__init__) `ApifyClient.__init__(token=None, *, api_url=None, max_retries=8, min_delay_between_retries_millis=500)`
 
 Initialize the Apify API Client.
 
 * **Parameters**
 
   * **token** (`str`, *optional*) – The Apify API token
 
-  * **base_url** (`str`, *optional*) – The URL of the Apify API server to which to connect to. Defaults to [https://api.apify.com/v2](https://api.apify.com/v2)
+  * **api_url** (`str`, *optional*) – The URL of the Apify API server to which to connect to. Defaults to [https://api.apify.com](https://api.apify.com)
 
   * **max_retries** (`int`, *optional*) – How many times to retry a failed request at most
 

src/apify_client/_version.py

@@ -1 +1 @@
-__version__ = '0.1.0'
+__version__ = '0.2.0'

src/apify_client/client.py

@@ -26,7 +26,8 @@
     WebhookDispatchCollectionClient,
 )
 
-DEFAULT_BASE_API_URL = 'https://api.apify.com/v2'
+DEFAULT_API_URL = 'https://api.apify.com'
+API_VERSION = 'v2'
 
 
 class ApifyClient:
@@ -36,21 +37,22 @@ def __init__(
         self,
         token: Optional[str] = None,
         *,
-        base_url: str = DEFAULT_BASE_API_URL,
+        api_url: Optional[str] = None,
         max_retries: int = 8,
         min_delay_between_retries_millis: int = 500,
     ):
         """Initialize the Apify API Client.
 
         Args:
             token (str, optional): The Apify API token
-            base_url (str, optional): The URL of the Apify API server to which to connect to. Defaults to https://api.apify.com/v2
+            api_url (str, optional): The URL of the Apify API server to which to connect to. Defaults to https://api.apify.com
             max_retries (int, optional): How many times to retry a failed request at most
             min_delay_between_retries_millis (int, optional): How long will the client wait between retrying requests
                 (increases exponentially from this value)
         """
         self.token = token
-        self.base_url = base_url
+        api_url = (api_url or DEFAULT_API_URL).rstrip('/')
+        self.base_url = f'{api_url}/{API_VERSION}'
         self.max_retries = max_retries
         self.min_delay_between_retries_millis = min_delay_between_retries_millis