launchpy 0.4.5.post5__tar.gz → 0.4.6__tar.gz

{launchpy-0.4.5.post5/launchpy.egg-info → launchpy-0.4.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: launchpy
-Version: 0.4.5.post5
+Version: 0.4.6
 Summary: Adobe Launch API wrapper
 Home-page: https://github.com/pitchmuc/launchpy
 Author: Julien Piccini

{launchpy-0.4.5.post5 → launchpy-0.4.6}/docs/releases.md

@@ -3,6 +3,9 @@
 This page gathered the changes made between version of the launchpy module.\
 This has been started after the 0.3.0 release.\
 
+## 0.4.6
+* Allow Synchronizer to be used in multi IMS organization setup.
+
 ## 0.4.5
 * adding `getExtension` in `Property` class
 * improve `upgradeExtension` in `Property` class
@@ -15,6 +18,9 @@ Patch:
 * Support of extension added in `createTargetsLibrary`
 * Fixing dependency to `aepp` `som` module
 * Fixing renaming path to use `renameComponent` and using `syncComponent`
+* Adding capability to set environment to a lib in `Library` instance via `setEnvironment`
+* Capability to get a `Library` class from the `getLibrary` method in `Property` instance
+* Fixing code in `deleteLibrary`
 
 ## 0.4.4
 * adding a `getBuilds` method on the `Library` class instance

{launchpy-0.4.5.post5 → launchpy-0.4.6}/docs/synchronizer.md

@@ -13,7 +13,6 @@ The Synchronizer will allow you to specify a template property and target proper
 This class is currently requiring the following elements on your side:
 
 * You have imported the config file (via `importConfigFile`) or configure your module via `configure` method.
-* Your template property and target properties are located in the same organization
 * You have unique name for your rule and data elements
 * You have the same extension installed in both the template and target properties.\
   The Synchronizer will not sync the extensions configuration.
@@ -24,8 +23,8 @@ If a rule and a data element have the same name, by passing that name in the `sy
 
 In order to instantiate the `Synchronizer` class, you will need to provide 2 elements:
 
-* The name of the base property (as string)
-* The names of the target properties (as a list of strings)
+* The name of the base property, as `string` or `launchpy.Property` instance
+* The names of the target properties (as a list of `strings`, or `launchpy.Property` instances)
 
 Example:
 
@@ -38,6 +37,56 @@ synchronizor = lp.Synchronizer(base='Prop1',targets=['Prop2'])
 
 ```
 
+### Multi Organization environments
+
+For some clients, they may want to synchronize the rules and data elements across organization setup.\
+That is possible, but the requirements are still needed regarding the following elements: 
+* You have unique name for your rule and data elements
+* You have the same extension installed in both the template and target properties.
+
+The synchronizer will use the environment credential lastly loaded in the system.\ 
+We would recommend to load first the target organization that you want to sync to, and then the base organization.\
+You will be able to use the Property instance of the target organization in order to sync the element afterwards.
+
+Example of setup
+
+```py
+import launchpy as lp
+
+
+### targeted org
+lp.importConfigFile('config_target.json')
+admin_target = lp.Admin()
+targetId = admin_target.getCompanyId()
+target_props = admin_target.getProperties(targetId)
+
+target_prop = lp.Property(target_props[1]) ## selecting one of the property
+
+### Source org for base
+lp.importConfigFile('config_source.json')
+admin = lp.Admin()
+sourceId = admin_target.getCompanyId()
+source_props = admin.getProperties(sourceId)
+
+base = lp.Property(source_props[0]) ### selecting the first one as base - it can be any
+
+synchronizor = lp.Synchronizer(base=base,targets=['another Property Name to sync',target_prop])
+
+### rest is as usual
+```
+
+If you have private extension that are not released between organization, you can pass a mapping to the synchronizer to tell that these extensions are to be treated as one.\
+You would need to pass the target extension name and the base extension name so that it is mapped as a single one.
+
+Example: 
+```py
+
+synchronizor = lp.Synchronizer(base=base,targets=['another Property Name to sync',target_prop],mapping_extensions={'extension_name_target':'extension_name_base'})
+
+```
+
+
+### Additional options
 There is a possibility to setup some rules so you can filter when migrating from one property to another. See [dynamic Filtering](#dynamic-component-filter)
 
 ## SyncComponent Method

launchpy-0.4.6/launchpy/__version__.py

@@ -0,0 +1 @@
+__version__ = "0.4.6"

{launchpy-0.4.5.post5 → launchpy-0.4.6}/launchpy/connector.py

@@ -31,7 +31,7 @@ class AdobeRequest:
             raise Exception(
                 'You have to upload the configuration file with importConfigFile method.')
         self.config = deepcopy(config_object)
-        self.header = header
+        self.header = deepcopy(header)
         self.retry = retry
         if self.config['token'] == '' or time.time() > self.config['date_limit']:
             if 'scopes' in self.config.keys() and self.config.get('scopes',None) is not None:
@@ -42,9 +42,9 @@ class AdobeRequest:
                 token_and_expiry = self.get_jwt_token_and_expiry_for_config(config=self.config, verbose=verbose)
             token = token_and_expiry['token']
             expiry = token_and_expiry['expiry']
-            self.token = token
-            self.config['token'] = token
-            self.config['date_limit'] = time.time() + expiry - 500
+            self.token = deepcopy(token)
+            self.config['token'] = deepcopy(token)
+            self.config['date_limit'] = deepcopy(time.time() + expiry - 500)
             self.header.update({'Authorization': f'Bearer {token}'})
 
     def get_jwt_token_and_expiry_for_config(self,config: dict, verbose: bool = False, save: bool = False, *args, **kwargs) -> Dict[str, str]:
@@ -166,8 +166,8 @@ class AdobeRequest:
             elif self.connectionType == 'jwt':
                 token_and_expiry = self.get_jwt_token_and_expiry_for_config(config=self.config)
             token = token_and_expiry['token']
-            self.config['token'] = token
-            self.config['date_limit'] = time.time() + token_and_expiry['expiry'] - 500
+            self.config['token'] = deepcopy(token)
+            self.config['date_limit'] = deepcopy(time.time() + token_and_expiry['expiry'] - 500)
             self.header.update({'Authorization': f'Bearer {token}'})
 
     def getData(self, endpoint: str, params: dict = None, data: dict = None, headers: dict = None, *args, **kwargs):

{launchpy-0.4.5.post5 → launchpy-0.4.6}/launchpy/launchpy.py

@@ -405,14 +405,23 @@ class Translator:
     --> You can use the translate method to translate Data Element settings 
     3. setBaseRules
     4. extendRules
-    --> You can use the translate method to translate Rule Components settings 
+    --> You can use the translate method to translate Rule Components settings
+
+    Possible arguments:
+        mapping_extensions : dictionary of extension names that should be replaced. 
+            Such as: {'old_name':'new_name'}
     """
 
-    def __init__(self):
+    def __init__(self,**kwargs):
         self.rules = {}
         self.baseRuleIdName = {}
         self.extensions = {}
         self.baseExtensionIdName = {}
+        self.mapping_extension = {}
+        if kwargs.get('mapping_extensions') is not None:
+            if type(kwargs.get('mapping_extensions')) == dict:
+                for key, value in kwargs.get('mapping_extensions').items():
+                    self.mapping_extension[key] = value
 
     def setBaseExtensions(self, base_property_extensions: list, property_name: str):
         """
@@ -422,8 +431,12 @@ class Translator:
             property_name : REQUIRED : name of your base property.
         """
         self.baseExtensionIdName = {ext['id'] : ext['attributes']['name'] for ext in base_property_extensions}
+        for extId, extName in self.baseExtensionIdName.items():
+            if extName in self.mapping_extension.keys():
+                self.baseExtensionIdName[extId] = self.mapping_extension[extName]
         self.extensions = {ext['attributes']['name']:{property_name:ext['id']} for ext in base_property_extensions}
 
+    
     def extendExtensions(self, new_property_extensions: list, new_prop_name: str)-> None:
         """
         Add the extensions id from a target property.
@@ -432,8 +445,11 @@ class Translator:
             new_prop_name : REQUIRED : target property name. 
         """
         for ext in new_property_extensions:
-            if ext['attributes']['name'] in list(self.extensions.keys()):
-                self.extensions[ext['attributes']['name']][new_prop_name] = ext['id']
+            extName = ext['attributes']['name']
+            if extName in self.mapping_extension.keys():
+                extName = self.mapping_extension[extName]
+            if extName in list(self.extensions.keys()):
+                self.extensions[extName][new_prop_name] = ext['id']
         return self.extensions
 
     def setBaseRules(self, base_property_rules: list, property_name: str):

{launchpy-0.4.5.post5 → launchpy-0.4.6}/launchpy/library.py

@@ -313,7 +313,7 @@ class Library:
 
     def setEnvironments(self, environments_list: list, dev_name: str = None)->None:
         """
-        Save the different environments ids available. 
+        Save the different environments ids available in a config variable.
         It is required to use the library class.
         Arguments : 
             environments_list : REQUIRED : list of environment retrieved by the getEnvironments method
@@ -340,6 +340,21 @@ class Library:
         res = new_env
         return res
 
+    def setEnvironment(self, env_id: str,verbose:bool=False)->None:
+        """
+        Set the environment of the library. 
+        Arguments:
+            env_id : REQUIRED : The environment id you want to set.
+        """
+        obj = {
+            "data": {
+                "id": env_id,
+                "type": "environments"
+            }
+        }
+        res = self._setEnvironment(obj,verbose=verbose)
+        return res
+
     def _removeEnvironment(self)->None:
         """
         Remove environment
@@ -347,7 +362,7 @@ class Library:
         path = f'/libraries/{self.id}/relationships/environment'
         new_env = self.connector.getData(self.endpoint+path) 
         return new_env
-    
+
     def updateLibrary(self,empty:bool=False)->dict:
         """
         Update the library
@@ -383,12 +398,14 @@ class Library:
         return res
 
 
-    def build(self,verbose:bool=False)->dict:
+    def build(self,timesleep:int=20, verbose:bool=False)->dict:
         """
         Build the library. 
         Part of the code takes care of assigning the right environement before building the library.
         Returns the build when it is completed (succeed or not).
-        It will check every 15 seconds for the build status, making sure it is not "pending".
+        Arguments:
+            timesleep : OPTIONAL : How many seconds to wait between each check of the build status. Default to 20 seconds.
+        It will check every 20 seconds for the build status, making sure it is not "pending".
         """
         if self.build_required == False and self.state != 'approved':
             return 'build is not required'
@@ -430,7 +447,7 @@ class Library:
         build_status = build['data']['attributes']['status']
         while build_status == 'pending':
             print('pending...')
-            time.sleep(20)
+            time.sleep(timesleep)
             # return the json directly
             build = self.connector.getData(
                 config.endpoints['global']+'/builds/'+str(build_id))

{launchpy-0.4.5.post5 → launchpy-0.4.6}/launchpy/property.py

@@ -603,7 +603,7 @@ class Property:
             data = data + append_data
         return data
 
-    def getLibrary(self,libraryId:str=None)->dict:
+    def getLibrary(self,libraryId:str=None,return_class:bool=False)->dict:
         """
         get a library based on its ID.
         Arguments:
@@ -614,6 +614,8 @@ class Property:
         path = f"/libraries/{libraryId}"
         res = self.connector.getData(self.endpoint+path)
         if 'data' in res.keys():
+            if return_class:
+                return Library(res['data'],config_object=self.connector.config,header=self.header)
             return res['data']
         return res
 
@@ -1278,7 +1280,10 @@ class Property:
         if library in librariesIds:
             libraryId = library
         else:
-            libraryId = librariesNameId[library]
+            try:
+                libraryId = librariesNameId[library]
+            except KeyError:
+                raise ValueError("Library name or ID provided not found.")
         path = f"/libraries/{libraryId}"
         if components==True:  
             myLib = self.getLibrary(libraryId)
@@ -1286,10 +1291,11 @@ class Property:
             rules = libClass.getRules()
             dataelements = libClass.getDataElements()
         res = self.connector.deleteData('https://reactor.adobe.io/'+path)
-        for rule in rules:
-            self.deleteRule(rule['id'])
-        for de in dataelements:
-            self.deleteDataElement(de['id'])
+        if components==True:
+            for rule in rules:
+                self.deleteRule(rule['id'])
+            for de in dataelements:
+                self.deleteDataElement(de['id'])
         return res
     
     def getProductionEndpoint(self)->dict:

{launchpy-0.4.5.post5 → launchpy-0.4.6}/launchpy/synchronizer.py

@@ -21,37 +21,48 @@ class Synchronizer:
     It requires that you have imported a configuration file.
     """
 
-    def __init__(self,base:str=None,targets:list=None,**kwargs)->None:
+    def __init__(self,base:str | Property = None,targets:list=None,**kwargs)->None:
         """
         Instantiating the Synchronizer taking 2 parameters, base property name, target property list.
         Arguments:
-            base : REQUIRED : The name of your base/template property
+            base : REQUIRED : The name of your base/template property or the instance of Property class
             targets : REQUIRED : The list of property names that you want to sync with.
+                the list of target can be string of property name or Property instance for other organization.
         possible kwargs:
             dynamicRuleComponent: A data element name that contains rule for synchronization on the property.
+            mapping_extensions : A dictionary of target extension name and base extension name when in different IMS org and 2 private extensions are name differently for the same purpose.
         """
         tmp_admin = Admin()
         cid = tmp_admin.getCompanyId()
         properties = tmp_admin.getProperties(cid)
-        base_property = [prop for prop in properties if prop['attributes']['name'] == base]
-        if len(base_property) ==0:
-            raise KeyError("The base property name has not been found in your account")
+        mapping_extensions = kwargs.get('mapping_extensions',None)
         self.base = {}
-        self.base["name"] = base
-        self.base["api"]:Property = Property(base_property[0])
+        if type(base) == str:
+            base_property = [prop for prop in properties if prop['attributes']['name'] == base]
+            if len(base_property) ==0:
+                raise KeyError("The base property name has not been found in your account")
+            self.base["name"] = base
+            self.base["api"]:Property = Property(base_property[0])
+        elif type(base) == Property:
+            self.base["name"] = base.name
+            self.base["api"]:Property = base
         self.base['rules'] = self.base['api'].getRules()
         self.base['dataElements'] = self.base['api'].getDataElements()
         self.base['extensions'] = self.base['api'].getExtensions()
-        self.translator = Translator()
+        self.translator = Translator(mapping_extensions=mapping_extensions)
         self.translator.setBaseExtensions(self.base['extensions'],self.base['name'])
         self.translator.setBaseRules(self.base['rules'],self.base['name'])
         self.targets = {}
         self.target_configs = {}
         for target in targets:
-            tmp_target = [prop for prop in properties if prop['attributes']['name'] == target]
-            if len(tmp_target) == 0:
-                raise KeyError(f"The target property : {target} cannot be found. Please, fix it")
-            self.targets[target] = {'api' : Property(tmp_target[0]),'name':target}
+            if isinstance(target,str):
+                tmp_target = [prop for prop in properties if prop['attributes']['name'] == target]
+                if len(tmp_target) == 0:
+                    raise KeyError(f"The target property : {target} cannot be found. Please, fix it")
+                self.targets[target] = {'api' : Property(tmp_target[0]),'name':target}
+            elif isinstance(target,Property):
+                self.targets[target.name] = {'api' : deepcopy(target),'name':target.name}
+                target = target.name
             self.targets[target]['rules'] = self.targets[target]['api'].getRules()
             self.targets[target]['extensions'] = self.targets[target]['api'].getExtensions()
             self.targets[target]['dataElements'] = self.targets[target]['api'].getDataElements()

{launchpy-0.4.5.post5 → launchpy-0.4.6/launchpy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: launchpy
-Version: 0.4.5.post5
+Version: 0.4.6
 Summary: Adobe Launch API wrapper
 Home-page: https://github.com/pitchmuc/launchpy
 Author: Julien Piccini

launchpy-0.4.5.post5/launchpy/__version__.py

@@ -1 +0,0 @@
-__version__ = "0.4.5-5"