launchpy 0.4.8__tar.gz → 0.4.9__tar.gz

{launchpy-0.4.8/launchpy.egg-info → launchpy-0.4.9}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: launchpy
-Version: 0.4.8
+Version: 0.4.9
 Summary: Adobe Launch API wrapper
 Author-email: Julien Piccini <piccini.julien@gmail.com>
 License: Apache License 2.0
@@ -28,6 +28,7 @@ Requires-Dist: pathlib
 Requires-Dist: aepp
 Requires-Dist: rich
 Requires-Dist: deprecated
+Requires-Dist: httpx
 Dynamic: license-file
 
 # Launchpy

{launchpy-0.4.8 → launchpy-0.4.9}/docs/cli.md

@@ -482,10 +482,10 @@ This command allows you to synchronize a library from the base property to the t
 **IMPORTANT**:By default it will use the published version of the elements that are part of the library. 
 * `-n`, `--name`: Name of the library to sync from. This is a required parameter.
 * `-id`, `--id`: ID of the library to sync from (overrides name if both provided). This is an optional parameter.
-* `-f`, `--force`: Boolean. Create the component if it does not exist. Default True. Possible values: True, False
-* `-ll`, `--library_linked`: Boolean. Whether to use library linked components or not. If set to True, the sync will be done using the library linked components. If set to False, the sync will be done using the component IDs in the library. Default True. Possible values: True, False
-* `-p`, `--published`: Boolean. Sync the latest published version of the component instead of the current version. Default False. Possible values: True, False
-* `-dr`, `--dry_run`: Boolean. If set to True, will only check the sync status of the components without actually syncing them. Default False. Possible values: True, False
+* `-c`, `--create`: Boolean. Create the component if it does not exist. Default `False`. Possible values: True, False
+* `-ll`, `--library_linked`: Boolean. Whether to use library linked components or not. If set to True, the sync will be done using the library linked components. If set to False, the sync will be done using the component IDs in the library. Default `True`. Possible values: True, False
+* `-p`, `--published`: Boolean. Sync the latest published version of the component instead of the current version. Default `False`. Possible values: True, False
+* `-dr`, `--dry_run`: Boolean. If set to True, will only check the sync status of the components without actually syncing them. Default `False`. Possible values: True, False
 
 ```bash
 synchronizer:Base_Property_Name> sync_from_library -id "LibraryId" -ll False -p True -dr True

{launchpy-0.4.8 → launchpy-0.4.9}/docs/releases.md

@@ -3,13 +3,19 @@
 This page gathered the changes made between version of the launchpy module.\
 This has been started after the 0.3.0 release.\
 
+## 0.4.9
+* fixing httpx dependency requirement
+* extractProperty will now also extract Data Elements and Extensions configurations in separate folders.
+* fix the argument handling for linkedLibrary in CLI.
+* Change of the `force` parameter to `create` in the synchronizer CLI for better understanding of the action. `create` is now default to `False`. The synchronizer module keeps its long name `forceCreation` for backward compatibility and better understanding of the action. Also turning it to `False` by default. 
+
 ## 0.4.8
 * Adding the `clear` method in CLI
 * Adding `syncFromLibrary` in synchronizer[doc](./synchronizer.md#syncFromLibrary).
 * Adding `sync_from_library` command in CLI[doc](./cli.md#sync_from_library-command).
 * Cleaning the JWT components and requirements
 * Adding the `definition` attribute in the Library class
-* Adding capability to define a specific environment name when creating a library in synchronizer
+* Adding capability to define a specific environment name when creating a library in synchronizer.
 
 ## 0.4.7
 * Modify `getRuleComponents` to `getRulesComponents` as it can return all the rules components if no rule is specified. Kept `getRuleComponents` as an alias for backward compatibility and also provide a single rule components retrieval.

{launchpy-0.4.8 → launchpy-0.4.9}/docs/synchronizer.md

@@ -146,7 +146,7 @@ This method allows you to take a library in your base property and sync all of t
 Arguments: 
 * library : REQUIRED : the name or the ID of the library to sync from.
 * state : OPTIONAL : the state of the library to sync from. Default: 'published', possible states: "development", "submitted", "approved", "rejected", "published"
-* force : OPTIONAL : If set to True, it will create the element sync if it does not exist in the target property. Set to `False`, it will prevent that behavior. Default: `True`.
+* create : OPTIONAL : If set to True, it will create the element sync if it does not exist in the target property. Set to `False`, it will prevent that behavior. Default: `False`.
 * libraryLinked : OPTIONAL : If set to True, it will use library linked components for comparison. Default: `True`.
 * publishedVersion : OPTIONAL : If set to True, it will compare the components to the published version in the target properties. Default: `False`.
 * dryRun : OPTIONAL : If set to True, will only check the sync status of the components without actually syncing them. Default `False`. Possible values: `True`, `False`

{launchpy-0.4.8 → launchpy-0.4.9}/launchpy/__init__.py

@@ -9,7 +9,7 @@ from launchpy.library import Library
 from launchpy.admin import Admin
 from launchpy.property import Property
 from launchpy.synchronizer import Synchronizer
-import re
+import re,json
 from pathlib import Path
 import httpx, asyncio
 
@@ -51,6 +51,15 @@ async def process_all_rules(rules_list, folder, header):
         # 'gather' runs them all concurrently
         await asyncio.gather(*tasks)
 
+
+async def write_all_data_elements(data_elements_list, folder, header):
+    for data_element in data_elements_list:
+        data_element_name = __safe_name__(data_element['attributes']['name'])
+        file_path = Path(folder) / f"{data_element_name}.json"
+        with open(file_path, "w") as f:
+            json.dump(data_element, f, indent=4)
+
+
 def extractProperty(property: dict | Property):
     if property is None:
         raise ValueError("Property is None")
@@ -62,4 +71,16 @@ def extractProperty(property: dict | Property):
     folder = __safe_name__(property.name)
     Path(folder).mkdir(parents=True, exist_ok=True)
     rules = property.getRules()
-    asyncio.run(process_all_rules(rules, folder, property.header))
+    asyncio.run(process_all_rules(rules, folder, property.header))
+    dataElements = property.getDataElements()
+    dataElements_folder = Path(folder) / "data_elements"
+    Path(dataElements_folder).mkdir(parents=True, exist_ok=True)
+    asyncio.run(write_all_data_elements(dataElements, dataElements_folder, property.header))
+    extension_folder = Path(folder) / "extensions"
+    extension_folder.mkdir(parents=True, exist_ok=True)
+    extensions = property.getExtensions()
+    for extension in extensions:
+        extension_name = __safe_name__(extension['attributes']['name'])
+        file_path = extension_folder / f"{extension_name}.json"
+        with open(file_path, "w") as f:
+            json.dump(extension, f, indent=4)

launchpy-0.4.9/launchpy/__version__.py

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

{launchpy-0.4.8 → launchpy-0.4.9}/launchpy/cli/__main__.py

@@ -568,13 +568,13 @@ class SynchronizerCLI(cmd.Cmd):
         parser.add_argument("-n", "--name", help="Name of the component to sync", type=str)
         parser.add_argument("-id", "--id", help="ID of the component to sync (overrides name if both provided)", type=str)
         parser.add_argument("-p", "--published", help="Boolean. Sync the latest published version of the component instead of the current version. Default False. Possible values: True, False", type=str2bool,  nargs="?", const=True, default=False)
-        parser.add_argument("-f", "--force", help="Boolean. Create the component if it does not exist. Default True. Possible values: True, False", type=str2bool, default=True)
+        parser.add_argument("-c", "--create", help="Boolean. Create the component if it does not exist. Default True. Possible values: True, False", type=str2bool, default=True)
         try:
             args = parser.parse_args(shlex.split(args))
             if args.id is not None:
-                result = self.synchronizer.syncComponent(componentId=args.id, publishedVersion=args.published, forceCreation=args.force)
+                result = self.synchronizer.syncComponent(componentId=args.id, publishedVersion=args.published, forceCreation=args.create)
             else:
-                result = self.synchronizer.syncComponent(componentName=args.name, publishedVersion=args.published, forceCreation=args.force)
+                result = self.synchronizer.syncComponent(componentName=args.name, publishedVersion=args.published, forceCreation=args.create)
             console.print(f"Component '{args.name or args.id}' synced successfully.", style="green")
         except Exception as e:
             console.print(f"(!) Error: {str(e)}", style="red")
@@ -765,8 +765,8 @@ class SynchronizerCLI(cmd.Cmd):
         parser = argparse.ArgumentParser(prog='sync_from_library', add_help=True)
         parser.add_argument("-n", "--name", help="Name of the library to sync from", type=str)
         parser.add_argument("-id", "--id", help="ID of the library to sync from (overrides name if both provided)", type=str)
-        parser.add_argument("-f", "--force", help="Boolean. Create the component if it does not exist. Default True. Possible values: True, False", type=str2bool, default=True)
-        parser.add_argument("-ll", "--library_linked", help="Boolean. Whether to use library linked components or not. If set to True, the sync will be done using the library linked components. If set to False, the sync will be done using the component IDs in the library. Default True. Possible values: True, False", type=str, default=True)
+        parser.add_argument("-c", "--create", help="Boolean. Create the component if it does not exist. Default True. Possible values: True, False", type=str2bool, default=False)
+        parser.add_argument("-ll", "--library_linked", help="Boolean. Whether to use library linked components or not. If set to True, the sync will be done using the library linked components. If set to False, the sync will be done using the component IDs in the library. Default True. Possible values: True, False", type=str2bool, default=True)
         parser.add_argument("-p", "--published", help="Boolean. Sync the latest published version of the component instead of the current version. Default False. Possible values: True, False", type=str2bool, nargs="?", const=True, default=False,)
         parser.add_argument("-dr", "--dry_run", help="Boolean. If set to True, will only check the sync status of the components without actually syncing them. Default False. Possible values: True, False", type=str2bool, nargs="?", const=True, default=False,)
         try:
@@ -808,7 +808,7 @@ class SynchronizerCLI(cmd.Cmd):
                             ruleId = rule['links']['self'].split('/').pop()
                         else:
                             ruleId = rule['id']
-                        self.synchronizer.syncComponent(componentId=ruleId, publishedVersion=publishedVersion, forceCreation=args.force,libraryLinked=libraryLinked)
+                        self.synchronizer.syncComponent(componentId=ruleId, publishedVersion=publishedVersion, forceCreation=args.create,libraryLinked=libraryLinked)
                         console.print(f"Rule '{rule['attributes']['name']}' synced successfully.", style="green")
                     except Exception as e:
                         console.print(f"(!) Error syncing rule '{rule['attributes']['name']}': {str(e)}", style="red")
@@ -820,7 +820,7 @@ class SynchronizerCLI(cmd.Cmd):
                             deId = de['links']['self'].split('/').pop()
                         else:
                             deId = de['id']
-                        self.synchronizer.syncComponent(componentId=deId, publishedVersion=publishedVersion, forceCreation=args.force,libraryLinked=libraryLinked)
+                        self.synchronizer.syncComponent(componentId=deId, publishedVersion=publishedVersion, forceCreation=args.create,libraryLinked=libraryLinked)
                         console.print(f"Data element '{de['attributes']['name']}' synced successfully.", style="green")
                     except Exception as e:
                         console.print(f"(!) Error syncing data element '{de['attributes']['name']}': {str(e)}", style="red")

{launchpy-0.4.8 → launchpy-0.4.9}/launchpy/synchronizer.py

@@ -217,7 +217,7 @@ class Synchronizer:
             cmp_baseDict = {'id':lib_cmp_base['id'],'name':lib_cmp_base['attributes']['name'],'component':lib_cmp_base,'copy':copySettings(lib_cmp_base)}
         return cmp_baseDict
 
-    def syncComponent(self,componentName:str=None,componentId:str=None,publishedVersion:bool=False,forceCreation:bool=True,**kwargs)->None:
+    def syncComponent(self,componentName:str=None,componentId:str=None,publishedVersion:bool=False,forceCreation:bool=False,**kwargs)->None:
         """
         Synchronize a component from the base property to the different target properties.
         It will detect the component with the same name in target properties.
@@ -227,7 +227,7 @@ class Synchronizer:
             componentName : REQUIRED : the name of the component to sync
             componentID : REQUIRED : the id of the component to sync
             publishedVersion : OPTIONAL : if you want to take the version that has been published
-            forceCreation : OPTIONAL : If the component does not exist in the target property, create it. Default: True
+            forceCreation : OPTIONAL : If the component does not exist in the target property, create it. Default: False
         possible kwargs:
             timeout : OPTIONAL : The timeout to be used for the rule component. If not provided, the existing timeout will be used.
             libraryLinked : OPTIONAL : If you want to take a component ID that are associated to a specific library. Default: False. If set to True, the method will look for the component in the library and take the version linked to the library instead of the latest version in the property. Do not work for Extensions.
@@ -384,20 +384,21 @@ class Synchronizer:
                             del self.targets[target]['rules'][index]
                             self.targets[target]['rules'].append(targetRule)
 
-    def syncComponents(self,componentsName:list=None,componentsId:list=None,publishedVersion:bool=False)->None:
+    def syncComponents(self,componentsName:list=None,componentsId:list=None,publishedVersion:bool=False,forceCreation:bool=False)->None:
         """
         Sync multiple components by looping through the list of name passed.
         Arguments:
             componentsName : REQUIRED : The list of component names to sync
             componentsId : REQUIRED : The list of component ID to sync
             publishedVersion : OPTIONAL : if you want to take the version that has been published
+            forceCreation : OPTIONAL : If set to True, it will sync the components even if they do not exist in the target properties. If set to False, it will only sync the components that already exist in the target properties. Default: False.
         """
         if componentsName is not None:
             for component in componentsName:
-                self.syncComponent(componentName=component,publishedVersion=publishedVersion)
+                self.syncComponent(componentName=component,publishedVersion=publishedVersion,forceCreation=forceCreation)
         if componentsId is not None:
             for component in componentsId:
-                self.syncComponent(componentId=component,publishedVersion=publishedVersion)
+                self.syncComponent(componentId=component,publishedVersion=publishedVersion,forceCreation=forceCreation)
     
     def createTargetsLibrary(self,name:str="syncComponents",assignEnv:bool|str=False)->None:
         """
@@ -781,13 +782,13 @@ class Synchronizer:
             dict_check[element_name] = self.checkComponentSync(componentId=element_id, excludeSimilar=excludeSimilar,publishedVersion=publishedVersion,libraryLinked=libraryLink)
         return dict_check
     
-    def syncFromLibrary(self,library:str=None,state='published',force:bool=True,libraryLinked:bool=True,publishedVersion:bool=False,dryRun:bool=False)->None:
+    def syncFromLibrary(self,library:str=None,state='published',forceCreation:bool=False,libraryLinked:bool=True,publishedVersion:bool=False,dryRun:bool=False)->None:
         """
         Sync the components in a library, from the base property, to the different target properties by using the createTargetsLibrary method.
         Arguments:
             library : REQUIRED : the library name or the library ID to get the components.
             state : OPTIONAL : the state of the library to compare. Default: 'published', possible states: "development", "submitted", "approved", "rejected", "published"
-            force : OPTIONAL : If set to True, it will sync the components even if they do not exist in the target properties. If set to False, it will only sync the components that already exist in the target properties. Default: True.
+            forceCreation : OPTIONAL : If set to True, it will sync the components even if they do not exist in the target properties. If set to False, it will only sync the components that already exist in the target properties. Default: False.
             libraryLinked : OPTIONAL : If set to True, it will sync the components using the library version. Default: False.
             publishedVersion : OPTIONAL : if you want to sync the version of the library that has been published in your base vs the published version of your target. Default: False.
             dryRun : OPTIONAL : If set to True, it will not actually sync the components but will return a dictionary with the components that would be synced and the target properties they would be synced to. Default: False.
@@ -820,7 +821,7 @@ class Synchronizer:
                         ruleId = rule['links']['self'].split('/').pop()
                     else:
                         ruleId = rule['id']
-                    self.syncComponent(componentId=ruleId,publishedVersion=publishedVersion, forceCreation=force,libraryLinked=libraryLinked)
+                    self.syncComponent(componentId=ruleId,publishedVersion=publishedVersion, forceCreation=forceCreation,libraryLinked=libraryLinked)
                 except:
                     print(f'Rule {rule["attributes"]["name"]} could not be updated in the target properties. Please check if the rule exist.')
         if len(dataelements)>0:
@@ -830,7 +831,7 @@ class Synchronizer:
                         deId = de['links']['self'].split('/').pop()
                     else:
                         deId = de['id']
-                    self.syncComponent(componentId=deId,publishedVersion=publishedVersion,forceCreation=force,libraryLinked=libraryLinked)
+                    self.syncComponent(componentId=deId,publishedVersion=publishedVersion,forceCreation=forceCreation,libraryLinked=libraryLinked)
                 except:
                     print(f'Data Element {de["attributes"]["name"]} could not be updated in the target properties. Please check if the data element exist.')
         return 

{launchpy-0.4.8 → launchpy-0.4.9/launchpy.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: launchpy
-Version: 0.4.8
+Version: 0.4.9
 Summary: Adobe Launch API wrapper
 Author-email: Julien Piccini <piccini.julien@gmail.com>
 License: Apache License 2.0
@@ -28,6 +28,7 @@ Requires-Dist: pathlib
 Requires-Dist: aepp
 Requires-Dist: rich
 Requires-Dist: deprecated
+Requires-Dist: httpx
 Dynamic: license-file
 
 # Launchpy

{launchpy-0.4.8 → launchpy-0.4.9}/launchpy.egg-info/requires.txt

@@ -5,3 +5,4 @@ pathlib
 aepp
 rich
 deprecated
+httpx

{launchpy-0.4.8 → launchpy-0.4.9}/pyproject.toml

@@ -32,7 +32,7 @@ dependencies = ['pandas',
                  "pathlib",
                  "aepp",
                  "rich",
-                 "deprecated"]
+                 "deprecated","httpx"]
 
 [project.urls]
 homepage = "https://github.com/pitchmuc/launchpy"

{launchpy-0.4.8 → launchpy-0.4.9}/requirements.txt

@@ -4,4 +4,5 @@ requests>=2.25.0
 aepp>=0.3.12
 pandas>=2.1.0
 rich>=14.0.0
-deprecated
+deprecated
+httpx>=0.24.0

launchpy-0.4.8/launchpy/__version__.py

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