aepp 0.4.2.post1__tar.gz → 0.4.3.post1__tar.gz

{aepp-0.4.2.post1/aepp.egg-info → aepp-0.4.3.post1}/PKG-INFO

@@ -1,10 +1,12 @@
 Metadata-Version: 2.4
 Name: aepp
-Version: 0.4.2.post1
+Version: 0.4.3.post1
 Summary: Package to manage AEP API endpoint and some helper functions
 Home-page: https://github.com/adobe/aepp
 Author: Julien Piccini
-Author-email: piccini.julien@gmail.com
+Author-email: Julien Piccini <piccini.julien@gmail.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/adobe/aepp
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: Apache Software License
@@ -21,16 +23,11 @@ Requires-Dist: pathlib2
 Requires-Dist: tenacity
 Requires-Dist: deprecation
 Requires-Dist: datamodel-code-generator
+Requires-Dist: rich
 Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: license-file
-Dynamic: requires-dist
 Dynamic: requires-python
-Dynamic: summary
 
 # Adobe Experience Platform API made for humans
 

{aepp-0.4.2.post1 → aepp-0.4.3.post1}/aepp/__init__.py

@@ -14,6 +14,7 @@ from aepp import connector
 from .configs import *
 from .__version__ import __version__
 from typing import Union
+import re
 
 ## other libraries
 from copy import deepcopy
@@ -83,8 +84,33 @@ def getPlatformEvents(
     return data
 
 
+def __make_filename_safe__(filename, replacement="_"):
+    # 1. Remove characters that are illegal in Windows or Linux
+    # Windows: < > : " / \ | ? * # Linux: / (and NULL)
+    filename = re.sub(r'[<>:"/\\|?*]', replacement, filename)
+    # 2. Remove control characters (ASCII 0-31)
+    filename = re.sub(r'[\x00-\x1f]', replacement, filename)
+    # 3. Trim whitespace and trailing dots (Windows doesn't like trailing dots)
+    filename = filename.strip().strip('.')
+    # 4. Handle Windows Reserved Names (CON, PRN, AUX, NUL, COM1, LPT1, etc.)
+    reserved_names = {
+        "CON", "PRN", "AUX", "NUL", "COM1", "COM2", "COM3", "COM4", "COM5",
+        "COM6", "COM7", "COM8", "COM9", "LPT1", "LPT2", "LPT3", "LPT4", "LPT5",
+        "LPT6", "LPT7", "LPT8", "LPT9"
+    }
+    # Check the base name without extension
+    base_name = os.path.splitext(filename)[0].upper()
+    if base_name in reserved_names:
+        filename = f"{replacement}{filename}"
+    # 5. Length limit (standard for most file systems is 255 chars)
+    if len(filename) > 255:
+        filename = filename[:255]
+    # 6. Default to a placeholder if the string is empty after cleaning
+    return filename if filename else "unnamed_file"
+
+
 def saveFile(
-    module: str = None,
+    module: str | None = None,
     file: object = None,
     filename: str = None,
     type_file: str = "json",
@@ -93,31 +119,39 @@ def saveFile(
     """
     Save the file in the approriate folder depending on the module sending the information.
      Arguments:
-          module: REQUIRED: Module requesting the save file.
+          module: OPTIONAL: Module requesting the save file.
           file: REQUIRED: an object containing the file to save.
           filename: REQUIRED: the filename to be used.
           type_file: REQUIRED: the type of file to be saveed(default: json)
           encoding : OPTIONAL : encoding used to write the file.
     """
-    if module is None:
-        raise ValueError("Require the module to create a folder")
     if file is None or filename is None:
         raise ValueError("Require a object for file and a name for the file")
     here = Path(Path.cwd())
-    folder = module.capitalize()
-    new_location = Path.joinpath(here, folder)
+    if module is not None:
+        folder = module.capitalize()
+        new_location = Path.joinpath(here, folder)
+    else:
+        new_location = here
     if new_location.exists() == False:
         new_location.mkdir()
+    filename = __make_filename_safe__(filename)
     if type_file == "json":
         filename = f"{filename}.json"
         complete_path = Path.joinpath(new_location, filename)
         with open(complete_path, "w", encoding=encoding) as f:
             f.write(json.dumps(file, indent=4))
-    else:
+    elif type_file == "txt":
         filename = f"{filename}.txt"
         complete_path = Path.joinpath(new_location, filename)
         with open(complete_path, "w", encoding=encoding) as f:
             f.write(file)
+    else:
+        filename = f"{filename}.{type_file}"
+        complete_path = Path.joinpath(new_location, filename)
+        with open(complete_path, "wb") as f:
+            f.write(file)
+    return complete_path
 
 def __titleSafe__(text: str) -> str:
     """
@@ -289,7 +323,7 @@ def extractSandboxArtefact(
         sandbox: REQUIRED: the instance of a ConnectObject that contains the sandbox information and connection.
         localFolder: OPTIONAL: the local folder where to extract the sandbox. If not provided, it will use the current working directory and name the folder the name of the sandbox.
         artefact: REQUIRED: the id or the name of the artefact to export.
-        artefactType: REQUIRED: the type of artefact to export. Possible values are: 'class','schema','fieldgroup','datatype','descriptor','dataset','identity','mergepolicy'
+        artefactType: REQUIRED: the type of artefact to export. Possible values are: 'class','schema','fieldgroup','datatype','descriptor','dataset','identity','mergepolicy',audience'
         region: OPTIONAL: the region of the sandbox (default: nld2). This is used to fetch the correct API endpoints for the identities. 
             Possible values: "va7","aus5", "can2", "ind2"
     """

aepp-0.4.3.post1/aepp/__version__.py

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

{aepp-0.4.2.post1 → aepp-0.4.3.post1}/aepp/flowservice.py

@@ -784,7 +784,7 @@ class FlowService:
                             authenticationRequired:bool=False
                             )-> dict:
         """
-        Create a streaming flow with or without transformation
+        Create a source flow streaming with or without transformation
             name : REQUIRED : The name of the Data Flow (Optional if you are just passing a datasetId).
             description : OPTIONAL : description of the Flow
             source_connection_id : REQUIRED : The ID of the source connection tied to Data Lake (Optional if you are just passing a datasetId).

{aepp-0.4.2.post1 → aepp-0.4.3.post1}/aepp/queryservice.py

@@ -227,6 +227,8 @@ class QueryService:
             if orderby == "+":
                 orderby = "%2B"
             arguments["orderby"] = orderby
+        else:
+            arguments["orderby"] = "-created"
         if start is not None:
             arguments["start"] = start
         if limit is not None:

{aepp-0.4.2.post1 → aepp-0.4.3.post1}/aepp/schema.py

@@ -261,6 +261,7 @@ class Schema:
             classFilter: str = None,
             excludeAdhoc: bool = True,
             output: str = 'raw',
+            prop: str = None,
             **kwargs
     ) -> list:
         """
@@ -285,6 +286,8 @@ class Schema:
             params["property"] = f"meta:extends=={classFilter}"
         elif excludeAdhoc:
             params["property"] = "meta:extends!=https://ns.adobe.com/xdm/data/adhoc"
+        if prop is not None:
+            params["property"] = prop
         verbose = kwargs.get("debug", False)
         privateHeader = deepcopy(self.header)
         format = kwargs.get("format", "xed-id")
@@ -1783,7 +1786,7 @@ class Schema:
         ]
         res = self.connector.patchData(self.endpoint + path,data=operation)
         return res
-    
+
     def enableSchemaForRealTime(self,schemaId:str=None)->dict:
         """
         Enable a schema for real time based on its ID.
@@ -1808,6 +1811,30 @@ class Schema:
         res = self.connector.patchData(self.endpoint + path,data=operation)
         return res
     
+    def enableSchemaForUPS(self,schemaId:str=None)->dict:
+        """
+        Enable a schema for UPS based on its ID.
+        Arguments:
+            schemaId : REQUIRED : The schema ID required to be updated
+        """
+        if schemaId is None:
+            raise Exception("Require a schema ID")
+        if schemaId.startswith("https://"):
+            from urllib import parse
+            schemaId = parse.quote_plus(schemaId)
+        if self.loggingEnabled:
+            self.logger.debug(f"Starting enableSchemaForUPS")
+        path = f"/{self.container}/schemas/{schemaId}/"
+        operation = [
+           { 
+            "op": "add",
+            "path": "/meta:immutableTags",
+            "value": ["union"]
+            }
+        ]
+        res = self.connector.patchData(self.endpoint + path,data=operation)
+        return res
+    
     def FieldGroupManager(self,fieldGroup:Union[dict,str,None],title:str=None,fg_class:list=["experienceevent","profile"]) -> 'FieldGroupManager':
          """
          Generates a field group Manager instance using the information provided by the schema instance.

{aepp-0.4.2.post1 → aepp-0.4.3.post1/aepp.egg-info}/PKG-INFO

@@ -1,10 +1,12 @@
 Metadata-Version: 2.4
 Name: aepp
-Version: 0.4.2.post1
+Version: 0.4.3.post1
 Summary: Package to manage AEP API endpoint and some helper functions
 Home-page: https://github.com/adobe/aepp
 Author: Julien Piccini
-Author-email: piccini.julien@gmail.com
+Author-email: Julien Piccini <piccini.julien@gmail.com>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/adobe/aepp
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
 Classifier: License :: OSI Approved :: Apache Software License
@@ -21,16 +23,11 @@ Requires-Dist: pathlib2
 Requires-Dist: tenacity
 Requires-Dist: deprecation
 Requires-Dist: datamodel-code-generator
+Requires-Dist: rich
 Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
 Dynamic: home-page
 Dynamic: license-file
-Dynamic: requires-dist
 Dynamic: requires-python
-Dynamic: summary
 
 # Adobe Experience Platform API made for humans
 

{aepp-0.4.2.post1 → aepp-0.4.3.post1}/aepp.egg-info/SOURCES.txt

@@ -1,6 +1,7 @@
 LICENSE
 MANIFEST.in
 README.md
+pyproject.toml
 setup.py
 aepp/__init__.py
 aepp/__version__.py
@@ -41,14 +42,6 @@ aepp/utils.py
 aepp.egg-info/PKG-INFO
 aepp.egg-info/SOURCES.txt
 aepp.egg-info/dependency_links.txt
+aepp.egg-info/entry_points.txt
 aepp.egg-info/requires.txt
-aepp.egg-info/top_level.txt
-tests/__init__.py
-tests/catalog_test.py
-tests/dataaccess_test.py
-tests/datasets_test.py
-tests/destinationinstanceservice_test.py
-tests/exportDatasetToDatalandingZone_test.py
-tests/flowservice_test.py
-tests/schema_test.py
-tests/som_test.py
+aepp.egg-info/top_level.txt

aepp-0.4.3.post1/aepp.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+aepp = aepp.cli.__main__:main

{aepp-0.4.2.post1 → aepp-0.4.3.post1}/aepp.egg-info/requires.txt

@@ -4,3 +4,4 @@ pathlib2
 tenacity
 deprecation
 datamodel-code-generator
+rich

aepp-0.4.3.post1/aepp.egg-info/top_level.txt

@@ -0,0 +1 @@
+aepp

aepp-0.4.3.post1/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "aepp"
+dynamic = ["version"]
+authors = [
+  { name="Julien Piccini", email="piccini.julien@gmail.com" },
+]
+description = "Package to manage AEP API endpoint and some helper functions"
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "Apache-2.0" }
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "License :: OSI Approved :: Apache Software License",
+    "Topic :: Utilities",
+    "Topic :: Internet",
+    "Topic :: Software Development :: Libraries",
+    "Development Status :: 2 - Pre-Alpha"
+]
+dependencies = [
+    "pandas",
+    "requests",
+    "pathlib2",
+    "tenacity",
+    "deprecation",
+    "datamodel-code-generator",
+    "rich"
+]
+
+[project.urls]
+"Homepage" = "https://github.com/adobe/aepp"
+
+[project.scripts]
+aepp = "aepp.cli.__main__:main"
+
+[tool.setuptools]
+packages = ["aepp"]
+include-package-data = true
+
+[tool.setuptools.dynamic]
+version = {attr = "aepp.__version__.__version__"}

{aepp-0.4.2.post1 → aepp-0.4.3.post1}/setup.py

@@ -39,6 +39,11 @@ setuptools.setup(
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/adobe/aepp",
+    entry_points={
+        'console_scripts': [
+            'aepp = aepp.cli.__main__:main',
+        ],
+    },
     packages=setuptools.find_packages(),
     include_package_data=True,
     classifiers=[
@@ -51,5 +56,5 @@ setuptools.setup(
         "Development Status :: 2 - Pre-Alpha"
     ],
     python_requires='>=3.10',
-    install_requires=['pandas', "requests", "pathlib2", "tenacity", "deprecation","datamodel-code-generator"],
+    install_requires=['pandas', "requests", "pathlib2", "tenacity", "deprecation","datamodel-code-generator","rich"],
 )

aepp-0.4.2.post1/aepp/__version__.py

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

aepp-0.4.2.post1/aepp.egg-info/top_level.txt

@@ -1,2 +0,0 @@
-aepp
-tests

aepp-0.4.2.post1/tests/__init__.py

@@ -1,10 +0,0 @@
-#  Copyright 2023 Adobe. All rights reserved.
-#  This file is licensed to you under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License. You may obtain a copy
-#  of the License at http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software distributed under
-#  the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
-#  OF ANY KIND, either express or implied. See the License for the specific language
-#  governing permissions and limitations under the License.
-

aepp-0.4.2.post1/tests/catalog_test.py

@@ -1,80 +0,0 @@
-#  Copyright 2023 Adobe. All rights reserved.
-#  This file is licensed to you under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License. You may obtain a copy
-#  of the License at http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software distributed under
-#  the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
-#  OF ANY KIND, either express or implied. See the License for the specific language
-#  governing permissions and limitations under the License.
-
-from aepp.schema import Schema
-import unittest
-from unittest.mock import patch, MagicMock
-
-
-class CatalogTest(unittest.TestCase):
-
-    def test_catalog_get_catalog__resource(self):
-        assert True
-
-    def test_catalog_decode_stream_batch(self):
-        assert True
-
-
-    def test_catalog_json_stream_messages(self):
-        assert True
-
-    def test_catalog_get_batches(self):
-        assert True
-
-    def test_catalog_get_failed_batches_df(self):
-        assert True
-
-    def test_catalog_get_batch(self):
-        assert True
-
-    def test_catalog_create_batch(self):
-        assert True
-
-    def test_catalog_get_resources(self):
-        assert True
-
-    def test_catalog_get_data_sets(self):
-        assert True
-
-    def test_catalog_create_datasets(self):
-        assert True
-
-    def test_catalog_get_data_set(self):
-        assert True
-
-    def test_catalog_delete_data_set(self):
-        assert True
-
-    def test_catalog_get_data_set_views(self):
-        assert True
-
-    def test_catalog_get_data_set_view(self):
-        assert True
-
-    def test_catalog_get_dataset_view_files(self):
-        assert True
-
-    def test_catalog_enable_dataset_profile(self):
-       assert True
-
-    def test_catalog_enable_dataset_identity(self):
-        assert True
-
-    def test_catalog_disable_dataset_profile(self):
-        assert True
-
-    def test_catalog_disable_dataset_identity(self):
-        assert True
-
-    def test_catalog_create_union_profile_dataset(self):
-        assert True
-
-    def test_catalog_get_mapper_errors(self):
-        assert True

aepp-0.4.2.post1/tests/dataaccess_test.py

@@ -1,36 +0,0 @@
-#  Copyright 2023 Adobe. All rights reserved.
-#  This file is licensed to you under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License. You may obtain a copy
-#  of the License at http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software distributed under
-#  the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
-#  OF ANY KIND, either express or implied. See the License for the specific language
-#  governing permissions and limitations under the License.
-
-from aepp.schema import Schema
-import unittest
-from unittest.mock import patch, MagicMock
-
-class DataAccessTest(unittest.TestCase):
-
-    def test_dataaccess_get_batch_files(self):
-        assert True
-
-    def test_dataaccess_get_batch_failed(self):
-        assert True
-
-    def test_dataaccess_get_batch_meta(self):
-        assert True
-
-    def test_dataaccess_getHeadFile(self):
-        assert True
-
-    def test_dataaccess_get_files(self):
-        assert True
-
-    def test_dataaccess_get_preview(self):
-        assert True
-
-    def test_dataaccess_get_resource(self):
-        assert True

aepp-0.4.2.post1/tests/datasets_test.py

@@ -1,30 +0,0 @@
-#  Copyright 2023 Adobe. All rights reserved.
-#  This file is licensed to you under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License. You may obtain a copy
-#  of the License at http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software distributed under
-#  the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
-#  OF ANY KIND, either express or implied. See the License for the specific language
-#  governing permissions and limitations under the License.
-
-from aepp.schema import Schema
-import unittest
-from unittest.mock import patch, MagicMock
-
-class DatasetsTest(unittest.TestCase):
-
-    def test_datasets_get_label_schema(self):
-        assert True
-
-    def test_datasets_head_label(self):
-        assert True
-
-    def test_datasets_delete_labels(self):
-        assert True
-
-    def test_datasets_create_labels(self):
-        assert True
-
-    def test_datasets_update_labels(self):
-        assert True

aepp-0.4.2.post1/tests/destinationinstanceservice_test.py

@@ -1,36 +0,0 @@
-#  Copyright 2023 Adobe. All rights reserved.
-#  This file is licensed to you under the Apache License, Version 2.0 (the "License");
-#  you may not use this file except in compliance with the License. You may obtain a copy
-#  of the License at http://www.apache.org/licenses/LICENSE-2.0
-#
-#  Unless required by applicable law or agreed to in writing, software distributed under
-#  the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
-#  OF ANY KIND, either express or implied. See the License for the specific language
-#  governing permissions and limitations under the License.
-
-from aepp.destinationinstanceservice import DestinationInstanceService
-import unittest
-from unittest.mock import patch, MagicMock, ANY
-
-
-class DestinationInstanceServiceTest(unittest.TestCase):
-    ADHOC_INPUT = {"flow1": ["dataset1"], "flow2": ["dataset2", "dataset3"]}
-    ADHOC_EXPECTED_PAYLOAD = {'activationInfo': {'destinations': [{'flowId': 'flow1', 'datasets': [{'id': 'dataset1'}]}, {'flowId': 'flow2', 'datasets': [{'id': 'dataset2'}, {'id': 'dataset3'}]}]}}
-    
-    @patch("aepp.connector.AdobeRequest")
-    def test_create_adhoc_dataset_export(self, mock_connector):
-        instance_conn = mock_connector.return_value
-        instance_conn.postData.return_value = {'foo'}
-        destination_instance_service_obj = DestinationInstanceService()
-        result = destination_instance_service_obj.createAdHocDatasetExport(self.ADHOC_INPUT)
-        assert(result is not None)
-        instance_conn.postData.assert_called_once()
-        instance_conn.postData.assert_called_with(ANY, data=self.ADHOC_EXPECTED_PAYLOAD)
-
-    @patch("aepp.connector.AdobeRequest")
-    def test_create_adhoc_dataset_export_invalid_input(self, mock_connector):
-        destination_instance_service_obj = DestinationInstanceService()
-        with self.assertRaises(Exception) as cm:
-            destination_instance_service_obj.createAdHocDatasetExport(None)
-        self.assertEqual('Require a dict for defining the flowId to datasetIds mapping', str(cm.exception))
-