updated iml docs

Signed-off-by: Kharude, Sachin <[email protected]>

Author: Kharude, Sachin

.github/workflows/main.yml

@@ -2,6 +2,8 @@ name: Tests
 
 on:
   push:
+    branches:
+    - master
   pull_request:
     branches:
       - master

README.md

@@ -135,18 +135,11 @@ You can provide your credentials using any of the following methods:
 - Credentials file
 
 #### Default credentials
+Place the credentials file into
 
-- Place the credentials file into:
-For Linux/MacOS: $HOME/.here/credentials.properties
-For Windows: %USERPROFILE%\.here\credentials.properties
+For Linux/MacOS: `$HOME/.here/credentials.properties`
 
-##### code snippet to initantiate LS object:
-```
-# credentials will be picked up from credentials.properties file placed at default location.
-from here_location_services import LS
-
-ls = LS()
-```
+For Windows: `%USERPROFILE%\.here\credentials.properties`
 
 #### Environment Variables
 
@@ -158,31 +151,11 @@ HERE_ACCESS_KEY_ID
 HERE_ACCESS_KEY_SECRET
 HERE_TOKEN_ENDPOINT_URL
 ```
-##### code snippet to initantiate LS object:
-```
-from here_location_services import LS
-from here_location_services.platform.credentials import PlatformCredentials
-
-
-credentials = PlatformCredentials.from_env()
-
-ls = LS(platfrom_credentials=credentials)
-```
 
 #### Credentials File
 
 You can specify any credentials file as an alternative to that found in `~/.here/credentials.properties`. An error is generated if there is no file present at the path, or if the file is not properly formatted.
-##### code snippet to initantiate LS object:
-
-```
-from here_location_services import LS
-from here_location_services.platform.credentials import PlatformCredentials
 
-
-credentials = PlatformCredentials.from_credentials_file("<Path to file>")
-
-ls = LS(platfrom_credentials=credentials)
-```
   
 ## Documentation
 
@@ -241,7 +214,7 @@ import geojson
 from xyzspaces import IML
 from xyzspaces.iml.credentials import Credentials
 
-credentials = Credentials.from_credentials_file("~/.here/credentials.properties")
+credentials = Credentials.from_default() # credentials are in either credentials file at default location or in environment variables
 
 layer_details = {
     "id": "demo-interactive-layer",

docs/source/prerequisites.rst

@@ -3,9 +3,10 @@ Prerequisites
 
 Before you install the ``xyzspaces`` package make sure you meet the following prerequisites:
 
+* A Python installation, 3.7+ recommended, with the ``pip`` or ``conda`` command available to install dependencies.
+
 Data Hub
 --------
-* A Python installation, 3.7+ recommended, with the ``pip`` or ``conda`` command available to install dependencies.
 * A HERE developer account, free and available under `HERE Developer Portal`_.
 * An XYZ API access token from your XYZ Hub server or the `XYZ portal`_ (see also its `Getting Started`_ section) in an environment variable named XYZ_TOKEN which you can set like this (with a valid value, of course)::
 
@@ -18,7 +19,6 @@ Data Hub
 
 Interactive Map Layer
 ---------------------
-* A Python installation, 3.7+ recommended, with the ``pip`` or ``conda`` command available to install dependencies.
 
 * To interact with Interactive Map Layers you will need an account on the HERE Platform. To get more details on the HERE Platform account please check our documentation `Get a HERE account <https://developer.here.com/documentation/identity-access-management/dev_guide/topics/obtain-user-credentials.html>`_.
 
@@ -56,12 +56,6 @@ Default credentials
 
    %USERPROFILE%\.here\credentials.properties
 
-code snippet to initantiate LS object::
-
-   # credentials will be picked up from credentials.properties file placed at default location.
-   from here_location_services import LS
-
-   ls = LS()
 
 Environment Variables
 ~~~~~~~~~~~~~~~~~~~~~~
@@ -73,27 +67,8 @@ You can override default credentials by assigning values to the following enviro
    HERE_ACCESS_KEY_SECRET
    HERE_TOKEN_ENDPOINT_URL
 
-code snippet to initantiate LS object::
-
-   from here_location_services import LS
-   from here_location_services.platform.credentials import PlatformCredentials
-
-
-   credentials = PlatformCredentials.from_env()
-
-   ls = LS(platfrom_credentials=credentials)
 
 Credentials File
 ~~~~~~~~~~~~~~~~
-You can specify any credentials file as an alternative to that found in `~/.here/credentials.properties`. An error is generated if there is no file present at the path, or if the file is not properly formatted.
-code snippet to initantiate LS object::
-
-   from here_location_services import LS
-   from here_location_services.platform.credentials import PlatformCredentials
-
-
-   credentials = PlatformCredentials.from_credentials_file("<Path to file>")
-
-   ls = LS(platfrom_credentials=credentials)
-
+You can specify any credentials file as an alternative to that found in ``~/.here/credentials.properties``. An error is generated if there is no file present at the path, or if the file is not properly formatted.
 

xyzspaces/iml/__init__.py

@@ -33,7 +33,8 @@ def from_catalog_hrn_and_layer_id(
         :return: Object of IML
         """
         obj = cls()
-        catalog = Catalog(hrn=catalog_hrn, credentials=credentials)
+        cred = credentials or Credentials.from_default()
+        catalog = Catalog(hrn=catalog_hrn, credentials=cred)
         obj.catalog = catalog
         obj.layer = InteractiveMapLayer(layer_id=layer_id, catalog=catalog)
         return obj