launchpy 0.4.3.post2__tar.gz → 0.4.4__tar.gz

{launchpy-0.4.3.post2/launchpy.egg-info → launchpy-0.4.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: launchpy
-Version: 0.4.3.post2
+Version: 0.4.4
 Summary: Adobe Launch API wrapper
 Home-page: https://github.com/pitchmuc/launchpy
 Author: Julien Piccini

{launchpy-0.4.3.post2 → launchpy-0.4.4}/docs/getstarted.md

@@ -26,7 +26,15 @@ lp.createConfigFile()
 This will create a JSON and you will need to fill it with the information available in your adobe io account.
 
 **NOTE**: scope in the config file has evolved over time so you can change it. Following this [link](https://www.adobe.io/authentication/auth-methods.html#!AdobeDocs/adobeio-auth/master/JWT/Scopes.md) to see the different scope possible.\
-By default, I will test the dev scope if the scope provided fails.
+You can change the `scope` attribute for one of these values: `"https://ims-na1.adobelogin.com/s/ent_reactor_admin_sdk"` or `"https://ims-na1.adobelogin.com/s/ent_reactor_sdk"`
+By default, I will test the dev scope if the scope provided fails. So normally nothing you need to do.
+
+**NOTE 2**: There is a possibility till end of 2024 to use the JWT.\
+launchpy supports both `jwt` and `oauthV2` authentication.\
+By default the latest version will try to use the `oauthV2`.\
+You can specify the keys generated in the config file by using the `auth_type` parameter.\
+Possible values : `oauthV2` (default) or `jwt`
+
 
 ## 4. Import the configuration file
 

{launchpy-0.4.3.post2 → launchpy-0.4.4}/docs/library.md

@@ -33,10 +33,10 @@ The different attributes are the following:
 
 * id : id of the library
 * name : name of the library
-* state : is it “development”, “staging” or “production” environment
+* state : is it "development", "staging" or "production" environment
 * build_required : is a build required or not (Boolean)
 * builds : The build attache to this library
-* buid_status : Is the last build has been “successful” ?
+* buid_status : Is the last build has been "successful" ?
 * relationships : the different element attached to this Library
 * _environments = a dictionary of the different environment possible.
 
@@ -45,10 +45,11 @@ The different attributes are the following:
 The get methods will enable you to retrieve the elements that have been attached to this library.
 The different get methods are the followings:
 
-* getDataElements
-* getExtensions
-* getRules
+* getDataElements : get the data element in that library
+* getExtensions : get the Extension in that library
+* getRules : get the rules in the library
 * getFullLibrary : It is a combinaison of all of the 3 above.
+* getBuilds : Retrieve the builds of that library
 
 ## Adding element to a library
 
@@ -62,7 +63,7 @@ They are the following:
 
 ## Environments settings
 
-Before you can actually start building the library and pass it from one state to another (“development” -> “staging”). You would need to set the different environments.
+Before you can actually start building the library and pass it from one state to another ("development" -> "staging"). You would need to set the different environments.
 
 The method used for that is : setEnvironments().
 It takes 2 arguments:
@@ -90,7 +91,7 @@ myLib.build() # require that you have set your environment.
 As it is your goal to publish your library, you want to transition it from the dev to the staging environment and so forth.
 In order to do that, you can use the transition() method.
 ***Note*** : You would need to build your library between 2 transition.
-At the end of the funnel, you just need to build your library when you are in the “approved” state.
+At the end of the funnel, you just need to build your library when you are in the "approved" state.
 The transition method takes 1 argument:
 
 * action : it can be either

{launchpy-0.4.3.post2 → launchpy-0.4.4}/docs/property.md

@@ -98,6 +98,10 @@ The different get methods are the following :
   Arguments:
   * element : REQUIRED : the element definition dictionary
 
+* **getProductionEndpoint** : Get the URL for the production library
+
+* **getStagingEndpoint** : Get the URL for the staging library
+
 
 ## Create methods
 

{launchpy-0.4.3.post2 → launchpy-0.4.4}/docs/releases.md

@@ -3,8 +3,16 @@
 This page gathered the changes made between version of the launchpy module.\
 This has been started after the 0.3.0 release.\
 
+## 0.4.4
+* adding a `getBuilds` method on the `Library` class instance
+* extend support for pagination on `getEnvironments`
+* adding `getProductionEndpoint` and `getStagingEndpoint` to retrieve the URL to use on websites
+* support the instantiation of the `Library` class via a single libraryId string. 
+
 ## 0.4.3
-* Refactor `Translator` class for removing `pandas` dependency
+* Refactor `Translator` class for removing `pandas` dependency\
+Patch:
+* Fix an issue with dependency on `target_configs` attribute in synchronizor.
 
 ## 0.4.2
 * Supporting the Oauth Token V2 authentication

{launchpy-0.4.3.post2 → launchpy-0.4.4}/docs/synchronizer.md

@@ -217,18 +217,9 @@ synchronizor.dynamicFiltering(myRules)
 ```
 
 
-### Usage of Dynamic Component filter
+### Dynamic Component filter check
 
-You would use that data element name during the instantiation of the synchronizer such as: 
-
-```python 
-synchronizor = lp.Synchronizer(base='BaseProperty',targets=['Target Property 1',
-                                                         'Target Property 2',
-                                                         'Target Property  3'],
-                               dynamicRuleComponent='syncFilter')
-```
-In this example above, `syncFilter` is the name of the data element containing that configuration.\
-Once your Synchronizer class has been instanciated, you can access 2 attributes in it to verify the correct setup.
+Once you have loaded your dynamic component rules in your Synchronizer class, you can access 2 attributes to verify the correct setup.
 
 * `dict_config` 
 The `dict_config` attribute will be a copy of your data element setup, but a dictionary instead of an array where all of the target properties rule will be a key.\
@@ -249,4 +240,12 @@ The logic that will be applied during the sync is the following:
     * IF the component name is in that list, **and not** in the `exclComponents` list, it will be sync
     * IF the component name is in that list **and** in the `exclComponents` list, it will **NOT** be sync
   * IF there is no list of `inclComponents` for that target property (or empty list), **and not** in the `exclComponents` list, the component will be synced
-* ELSE: it will be sync
+* ELSE: it will be sync
+
+### Regular expression in Python
+
+One common issue seeing the pattern used in Regular Expression is the use of the quantifier `*` without any character before.\
+This can lead to some errors when using the following regular expression: `*some pattern*`\
+This type of pattern needs to be replaced by `.*some pattern.*`\
+
+The `*` is a quantifier that needs to have a character before it so it can know which character or pattern to repeat (or not).

launchpy-0.4.4/launchpy/__version__.py

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

{launchpy-0.4.3.post2 → launchpy-0.4.4}/launchpy/library.py

@@ -1,13 +1,14 @@
 import time
 # Non standard libraries
 from launchpy import config, connector
+from typing import Union
 
 class Library:
     """
     A class that handle the library in a Launch environment.
     """
 
-    def __init__(self, data: dict,config_object:dict=config.config_object,header:dict=config.header):
+    def __init__(self, data: Union[str,dict],config_object:dict=config.config_object,header:dict=config.header):
         """
         The instantiator for the library.
         Arguments:
@@ -19,6 +20,8 @@ class Library:
             config_object=config_object, header=header)
         self.header = self.connector.header
         self.endpoint = config.endpoints['global']
+        if type(data) == str:
+            data = self.connector.getData("https://reactor.adobe.io/libraries/"+data).get('data')
         self.id = data['id']
         self.name = data['attributes']['name']
         self.state = data['attributes']['state']
@@ -100,6 +103,23 @@ class Library:
             return dataOrigin
         self.relationships['extensions'] = data
         return data
+    
+    def getBuilds(self)->list:
+        """
+        Retrieve the last builds.
+        Return a list of build
+        """
+        params = {'page[number]':1}
+        res = self.connector.getData(self._Builds,params=params)
+        builds = res.get('data',[])
+        next_page = res.get('meta',{}).get('pagination',{}).get('next_page',None)
+        while next_page is not None:
+            params['page[number]'] +=1
+            res = self.connector.getData(self._Builds,params=params)
+            builds += res.get('data',[])
+            next_page = res.get('meta',{}).get('pagination',{}).get('next_page',None)
+        return builds
+
 
     def getRules(self,page:int=0,pageSize:int=50,origin:bool=True)->list:
         """
@@ -296,7 +316,7 @@ class Library:
         Save the different environments ids available. 
         It is required to use the library class.
         Arguments : 
-            environments_list : REQUIRED : list of environment retrieved by the getEnvironment method
+            environments_list : REQUIRED : list of environment retrieved by the getEnvironments method
             dev_name : OPTIONAL : Name of your dev environment. If not defined, will take the first dev environment.
         """
         for env in environments_list:

{launchpy-0.4.3.post2 → launchpy-0.4.4}/launchpy/property.py

@@ -99,8 +99,15 @@ class Property:
         """
         Retrieve the environment sets for this property
         """
+        params = {"page[number]":1}
         env = self.connector.getData(self._Environments)
         data = env['data']  # skip meta for now
+        next_page = env.get('meta',{}).get('pagination',{}).get('next_page',None)
+        while next_page is not None:
+            params['page[number]'] = next_page
+            env = self.connector.getData(self._Environments,params=params)
+            data += env.get('data',[])
+            next_page = env.get('meta',{}).get('pagination',{}).get('next_page',None)
         return data
 
     def getHost(self)->object:
@@ -258,9 +265,9 @@ class Property:
         """
         filters = {}
         if name != None:
-            filters['filter[name]=CONTAINS '] = f"EQ {name}"
+            filters['filter[name]'] = f"EQ {name}"
         if name_contains != None:
-            filters['filter[name]=CONTAINS '] = f"CONTAINS {name_contains}"
+            filters['filter[name]'] = f"CONTAINS {name_contains}"
         if dirty != None:
             filters['filter[dirty]'] = f"EQ {str(dirty).lower()}"
         if enabled != None:
@@ -1187,6 +1194,22 @@ class Property:
         for de in dataelements:
             self.deleteDataElement(de['id'])
         return res
+    
+    def getProductionEndpoint(self)->dict:
+        """
+        Returns the production library URL to use on the website
+        """
+        envs = self.getEnvironments()
+        prod = [env for env in envs if env['attributes']['stage'] == 'production'][0]
+        return prod['meta']['script_sources'][0]["license_path"]
+
+    def getStagingEndpoint(self)->dict:
+        """
+        Returns the staging library URL to use on the website
+        """
+        envs = self.getEnvironments()
+        staging = [env for env in envs if env['attributes']['stage'] == 'staging'][0]
+        return staging['meta']['script_sources'][0]["license_path"]
 
 def extensionsInfo(data: list)->dict:
     """
@@ -1551,4 +1574,4 @@ def extractAnalyticsCode(rcSettings: str, save: bool = False, filename: str = No
         filename = filename.replace('/', '_').replace('|', '_')
         if save:
             saveFile(json_code,filename,type='js',encoding=encoding)
-        return json_code
+        return json_code

{launchpy-0.4.3.post2 → launchpy-0.4.4}/launchpy/synchronizer.py

@@ -45,6 +45,7 @@ class Synchronizer:
         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:

{launchpy-0.4.3.post2 → launchpy-0.4.4/launchpy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: launchpy
-Version: 0.4.3.post2
+Version: 0.4.4
 Summary: Adobe Launch API wrapper
 Home-page: https://github.com/pitchmuc/launchpy
 Author: Julien Piccini

launchpy-0.4.3.post2/launchpy/__version__.py

@@ -1 +0,0 @@
-__version__ = "0.4.3-2"