PyPI - python4cpm - Versions diffs - 1.0.19__tar.gz → 1.0.21__tar.gz - Mend

python4cpm 1.0.19tar.gz → 1.0.21tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (16) hide show

{python4cpm-1.0.19/src/python4cpm.egg-info → python4cpm-1.0.21}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python4cpm
-Version: 1.0.19
+Version: 1.0.21
 Summary: Python for CPM
 Author-email: Gonzalo Atienza Rela <gonatienza@gmail.com>
 License: MIT License
@@ -25,7 +25,7 @@ License: MIT License
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
         THE SOFTWARE.
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Dynamic: license-file
@@ -40,29 +40,41 @@ This platform allows you to duplicate it multiple times, simply changing its set
 ### Preparing Python
-1. Install Python in CPM.  **Python must be installed for all users when running the install wizard**.
-2. Create a venv in CPM, by running `py -m venv c:\venv`.  Use the default location `c:\venv` or a custom one (e.g., `c:\my-venv-path`).
-3. Install `python4cpm` in your venv:
+1. Install Python in CPM.
+    - **Python must be installed for all users**.  Follow the custom install steps from the installation wizard to check the checkbox.
+3. Create a venv in CPM, by running `py -m venv c:\venv`.  If desired, use a custom location and adjust any future references.
+4. Install `python4cpm` in your venv:
     - If your CPM can connect to the internet, install with `c:\venv\Scripts\pip install python4cpm`.
     - If your CPM cannot connect to the internet:
-        - Download the latest `*.whl` file from the [pypi project files](https://pypi.org/project/python4cpm/#files).
+        - Download the latest `python4cpm-*.whl` file from the [pypi project files](https://pypi.org/project/python4cpm/#files).
         - Copy the file to CPM and extract to a temporary directory called `python4cpm-wheel`.
         - From the parent directory of `python4cpm-wheel` run `c:\venv\Scripts\pip install --no-index --find-links=.\python4cpm-wheel python4cpm`.
 ### Importing the platform
-1. Download the latest [Credential Management .NET SDK](https://community.cyberark.com/marketplace/s/#a3550000000EkA0AAK-a3950000000jjoOAAQ) and place its content in the bin folder of CPM (`C:\Program Files (x86)\CyberArk\Password Manager\bin`).
-2. Download the `python4cpm-platform.zip` asset from the [release](https://github.com/gonatienza/python4cpm/releases).
+#### If you are using CPM (SaaS or Self-Hosted):
+1. Download the latest [Credential Management .NET SDK](https://community.cyberark.com/marketplace/s/#a3550000000EkA0AAK-a3950000000jjoOAAQ) and place its content in the bin folder of CPM (`C:\Program Files (x86)\CyberArk\Password Manager\bin`).  The files for this may already be present.
+2. Download the `python4cpm-platform-*.zip` asset from the [release](https://github.com/gonatienza/python4cpm/releases).
 3. Import the platform zip file into Privilege Cloud/PVWA `(Administration -> Platform Management -> Import platform)`.
-4. Craft your python script and place it within the bin folder of CPM (`C:\Program Files (x86)\CyberArk\Password Manager\bin`).
+4. Craft your python script and place it within a folder in CPM (e.g., `C:\python4cpm-scripts`).
 5. Duplicate the imported platform in Privilege Cloud/PVWA `(Administration -> Platform Management -> Application -> Python for CPM)` and name it after your application (e.g., My App).
-6. Edit the duplicated platform and specify the path of your placed script in the bin folder of CPM, under `Target Account Platform -> Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonScriptPath -> Value` (e.g., `bin\myapp.py`).
-7. If you used a custom venv location, also update `Target Account Platform -> Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonExePath -> Value` with the custom path for the venv's `python.exe` file (e.g., `c:\my-venv-path\Scripts\python.exe`).
+6. Edit the duplicated platform and specify the path of your script, under `Target Account Platform -> Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonScriptPath -> Value` (e.g., `C:\python4cpm-scripts\myapp.py`).
+7. Also update `Target Account Platform -> Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonExePath -> Value` with the custom path for the venv's `python.exe` file (e.g., `c:\venv\Scripts\python.exe`).
 8. If you want to disable logging, update `Target Account Platform -> Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonLogging -> Value` to `no`.
 9. If you want to change the logging level to `debug`, update `Target Account Platform -> Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonLoggingLevel -> Value` to `debug`.
 10. For new applications repeat steps from 4 to 9.
+#### If you are using SRS (SaaS only):
+1. Download the `python4cpm-platform-*.zip` asset from the [release](https://github.com/gonatienza/python4cpm/releases).
+2. Import the platform zip file into Privilege Cloud `(Administration -> Platform Management -> Import platform)`.
+3. Craft your python script and place it within a folder in the Cloud Connector (where the SRS Management Agent runs) (e.g., `C:\python4cpm-scripts`).
+4. Duplicate the imported platform in Privilege Cloud/PVWA `(Administration -> Platform Management -> Application -> Python for CPM)` and name it after your application (e.g., My App).
+5. Edit the duplicated platform and specify the path of your script, under `Plugin Settings -> Additional Parameters -> PythonScriptPath` (e.g., `C:\python4cpm-scripts\myapp.py`).
+6. Also update `Plugin Settings -> Additional Parameters -> PythonExePath` with the custom path for the venv's `python.exe` file (e.g., `c:\venv\Scripts\python.exe`).
+7. If you want to disable logging, update `Plugin Settings -> Additional Parameters -> PythonLogging` to `no`.
+8. If you want to change the logging level to `debug`, update `Plugin Settings -> Additional Parameters -> PythonLoggingLevel -> Value` to `debug`.
+9. For new applications repeat steps from 3 to 8.
 ## Python Script
@@ -93,11 +105,12 @@ p4cpm.log_info("this is an info message") # logs info into Logs/ThirdParty/Pytho
 # Logging level -> Will only log debug messages if Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonLoggingLevel is set to debug (default is info)
 p4cpm.log_debug("this is an debug message") # logs info into Logs/ThirdParty/Python4CPM/MyApp.log if logging level is set to debug
-# Terminate signals -> ALWAYS use one of the following three signals to terminate the script
+# Terminate signals -> MUST use one of the following three signals to terminate the script:
 ## p4cpm.close_success() # terminate with success state
 ## p4cpm.close_fail() # terminate with recoverable failed state
 ## p4cpm.close_fail(unrecoverable=True) # terminate with unrecoverable failed state
-# If no signal is call, CPM will not know if the action was successful and display an error
+# When calling a signal sys.exit is invoked and the script is terminated.
+# If no signal is called, and the script finishes without any exception, it will behave like p4cpm.close_fail(unrecoverable=True) and log an error message.
 # Verification example -> verify the username and password are valid
@@ -171,7 +184,7 @@ if __name__ == "__main__":
 When doing `verify`, `change` or `reconcile` from Privilege Cloud/PVWA:
 1. Verify -> the sciprt will be executed once with the `p4cpm.args.action` as `Python4CPM.ACTION_VERIFY`.
 2. Change -> the sciprt will be executed twice, once with the action `p4cpm.args.action` as `Python4CPM.ACTION_LOGON` and once as `Python4CPM.ACTION_CHANGE`.
-    - If all actions are not terminated with `p4cpm.close_success()` the overall change will fail.
+    - If all actions are not terminated with `p4cpm.close_success()` and the scripts terminates without any exception, it defaults to a successful return.
 3. Reconcile -> the sciprt will be executed twice, once with the `p4cpm.args.action` as `Python4CPM.ACTION_PRERECONCILE` and once as `Python4CPM.ACTION_RECONCILE`.
     - If all actions are not terminated with `p4cpm.close_success()` the overall reconcile will fail.
 4. When `p4cpm.args.action` comes as `Python4CPM.ACTION_VERIFY`, `Python4CPM.ACTION_LOGON` or `Python4CPM.ACTION_PRERECONCILE`: `p4cpm.secrets.new_password.get()` will always return an empty string.

{python4cpm-1.0.19 → python4cpm-1.0.21}/README.md RENAMED Viewed

@@ -8,29 +8,41 @@ This platform allows you to duplicate it multiple times, simply changing its set
 ### Preparing Python
-1. Install Python in CPM.  **Python must be installed for all users when running the install wizard**.
-2. Create a venv in CPM, by running `py -m venv c:\venv`.  Use the default location `c:\venv` or a custom one (e.g., `c:\my-venv-path`).
-3. Install `python4cpm` in your venv:
+1. Install Python in CPM.
+    - **Python must be installed for all users**.  Follow the custom install steps from the installation wizard to check the checkbox.
+3. Create a venv in CPM, by running `py -m venv c:\venv`.  If desired, use a custom location and adjust any future references.
+4. Install `python4cpm` in your venv:
     - If your CPM can connect to the internet, install with `c:\venv\Scripts\pip install python4cpm`.
     - If your CPM cannot connect to the internet:
-        - Download the latest `*.whl` file from the [pypi project files](https://pypi.org/project/python4cpm/#files).
+        - Download the latest `python4cpm-*.whl` file from the [pypi project files](https://pypi.org/project/python4cpm/#files).
         - Copy the file to CPM and extract to a temporary directory called `python4cpm-wheel`.
         - From the parent directory of `python4cpm-wheel` run `c:\venv\Scripts\pip install --no-index --find-links=.\python4cpm-wheel python4cpm`.
 ### Importing the platform
-1. Download the latest [Credential Management .NET SDK](https://community.cyberark.com/marketplace/s/#a3550000000EkA0AAK-a3950000000jjoOAAQ) and place its content in the bin folder of CPM (`C:\Program Files (x86)\CyberArk\Password Manager\bin`).
-2. Download the `python4cpm-platform.zip` asset from the [release](https://github.com/gonatienza/python4cpm/releases).
+#### If you are using CPM (SaaS or Self-Hosted):
+1. Download the latest [Credential Management .NET SDK](https://community.cyberark.com/marketplace/s/#a3550000000EkA0AAK-a3950000000jjoOAAQ) and place its content in the bin folder of CPM (`C:\Program Files (x86)\CyberArk\Password Manager\bin`).  The files for this may already be present.
+2. Download the `python4cpm-platform-*.zip` asset from the [release](https://github.com/gonatienza/python4cpm/releases).
 3. Import the platform zip file into Privilege Cloud/PVWA `(Administration -> Platform Management -> Import platform)`.
-4. Craft your python script and place it within the bin folder of CPM (`C:\Program Files (x86)\CyberArk\Password Manager\bin`).
+4. Craft your python script and place it within a folder in CPM (e.g., `C:\python4cpm-scripts`).
 5. Duplicate the imported platform in Privilege Cloud/PVWA `(Administration -> Platform Management -> Application -> Python for CPM)` and name it after your application (e.g., My App).
-6. Edit the duplicated platform and specify the path of your placed script in the bin folder of CPM, under `Target Account Platform -> Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonScriptPath -> Value` (e.g., `bin\myapp.py`).
-7. If you used a custom venv location, also update `Target Account Platform -> Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonExePath -> Value` with the custom path for the venv's `python.exe` file (e.g., `c:\my-venv-path\Scripts\python.exe`).
+6. Edit the duplicated platform and specify the path of your script, under `Target Account Platform -> Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonScriptPath -> Value` (e.g., `C:\python4cpm-scripts\myapp.py`).
+7. Also update `Target Account Platform -> Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonExePath -> Value` with the custom path for the venv's `python.exe` file (e.g., `c:\venv\Scripts\python.exe`).
 8. If you want to disable logging, update `Target Account Platform -> Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonLogging -> Value` to `no`.
 9. If you want to change the logging level to `debug`, update `Target Account Platform -> Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonLoggingLevel -> Value` to `debug`.
 10. For new applications repeat steps from 4 to 9.
+#### If you are using SRS (SaaS only):
+1. Download the `python4cpm-platform-*.zip` asset from the [release](https://github.com/gonatienza/python4cpm/releases).
+2. Import the platform zip file into Privilege Cloud `(Administration -> Platform Management -> Import platform)`.
+3. Craft your python script and place it within a folder in the Cloud Connector (where the SRS Management Agent runs) (e.g., `C:\python4cpm-scripts`).
+4. Duplicate the imported platform in Privilege Cloud/PVWA `(Administration -> Platform Management -> Application -> Python for CPM)` and name it after your application (e.g., My App).
+5. Edit the duplicated platform and specify the path of your script, under `Plugin Settings -> Additional Parameters -> PythonScriptPath` (e.g., `C:\python4cpm-scripts\myapp.py`).
+6. Also update `Plugin Settings -> Additional Parameters -> PythonExePath` with the custom path for the venv's `python.exe` file (e.g., `c:\venv\Scripts\python.exe`).
+7. If you want to disable logging, update `Plugin Settings -> Additional Parameters -> PythonLogging` to `no`.
+8. If you want to change the logging level to `debug`, update `Plugin Settings -> Additional Parameters -> PythonLoggingLevel -> Value` to `debug`.
+9. For new applications repeat steps from 3 to 8.
 ## Python Script
@@ -61,11 +73,12 @@ p4cpm.log_info("this is an info message") # logs info into Logs/ThirdParty/Pytho
 # Logging level -> Will only log debug messages if Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonLoggingLevel is set to debug (default is info)
 p4cpm.log_debug("this is an debug message") # logs info into Logs/ThirdParty/Python4CPM/MyApp.log if logging level is set to debug
-# Terminate signals -> ALWAYS use one of the following three signals to terminate the script
+# Terminate signals -> MUST use one of the following three signals to terminate the script:
 ## p4cpm.close_success() # terminate with success state
 ## p4cpm.close_fail() # terminate with recoverable failed state
 ## p4cpm.close_fail(unrecoverable=True) # terminate with unrecoverable failed state
-# If no signal is call, CPM will not know if the action was successful and display an error
+# When calling a signal sys.exit is invoked and the script is terminated.
+# If no signal is called, and the script finishes without any exception, it will behave like p4cpm.close_fail(unrecoverable=True) and log an error message.
 # Verification example -> verify the username and password are valid
@@ -139,7 +152,7 @@ if __name__ == "__main__":
 When doing `verify`, `change` or `reconcile` from Privilege Cloud/PVWA:
 1. Verify -> the sciprt will be executed once with the `p4cpm.args.action` as `Python4CPM.ACTION_VERIFY`.
 2. Change -> the sciprt will be executed twice, once with the action `p4cpm.args.action` as `Python4CPM.ACTION_LOGON` and once as `Python4CPM.ACTION_CHANGE`.
-    - If all actions are not terminated with `p4cpm.close_success()` the overall change will fail.
+    - If all actions are not terminated with `p4cpm.close_success()` and the scripts terminates without any exception, it defaults to a successful return.
 3. Reconcile -> the sciprt will be executed twice, once with the `p4cpm.args.action` as `Python4CPM.ACTION_PRERECONCILE` and once as `Python4CPM.ACTION_RECONCILE`.
     - If all actions are not terminated with `p4cpm.close_success()` the overall reconcile will fail.
 4. When `p4cpm.args.action` comes as `Python4CPM.ACTION_VERIFY`, `Python4CPM.ACTION_LOGON` or `Python4CPM.ACTION_PRERECONCILE`: `p4cpm.secrets.new_password.get()` will always return an empty string.

{python4cpm-1.0.19 → python4cpm-1.0.21}/pyproject.toml RENAMED Viewed

@@ -4,13 +4,13 @@ build-backend = "setuptools.build_meta"
 [project]
 name = "python4cpm"
-version = "1.0.19"
+version = "1.0.21"
 description = "Python for CPM"
 authors = [
   { name = "Gonzalo Atienza Rela", email = "gonatienza@gmail.com" }
 ]
 dependencies = []
-requires-python = ">=3.8"
+requires-python = ">=3.10"
 readme = { file = "README.md", content-type = "text/markdown" }
 license = { file = "LICENSE" }

{python4cpm-1.0.19 → python4cpm-1.0.21}/src/python4cpm/logger.py RENAMED Viewed

@@ -3,12 +3,12 @@ import logging
 from logging.handlers import RotatingFileHandler
-_LOGS_DIR = os.path.join("Logs", "ThirdParty", "Python4CPM")
+_LOGS_DIR = os.path.join("Logs", "ThirdParty")
 _LOGGING_ENABLED_VALUE = "yes"
 _LOGGING_LEVELS = {
     "info": logging.INFO,
     "debug": logging.DEBUG
-    }
+}
 def get_logger(
@@ -16,17 +16,14 @@ def get_logger(
     args_logging: str,
     args_logging_level: str
 ) -> logging.Logger:
-    if args_logging is None:
-        return None
     if args_logging.lower() != _LOGGING_ENABLED_VALUE:
         return None
     os.makedirs(_LOGS_DIR, exist_ok=True)
-    logs_file = os.path.join(_LOGS_DIR, f"{name}.log")
+    logs_file = os.path.join(_LOGS_DIR, f"{__name__}-{name}.log")
     _id = os.urandom(4).hex()
     logger = logging.getLogger(_id)
-    logging_level = args_logging_level.lower()
-    if logging_level in _LOGGING_LEVELS:
-        logger.setLevel(_LOGGING_LEVELS[logging_level])
+    if args_logging_level.lower() in _LOGGING_LEVELS:
+        logger.setLevel(_LOGGING_LEVELS[args_logging_level.lower()])
     else:
         logger.setLevel(_LOGGING_LEVELS["info"])
     handler = RotatingFileHandler(

{python4cpm-1.0.19 → python4cpm-1.0.21}/src/python4cpm/python4cpm.py RENAMED Viewed

@@ -1,5 +1,6 @@
 import os
 import sys
+import atexit
 import logging
 from python4cpm.secrets import Secrets
 from python4cpm.args import Args
@@ -19,15 +20,14 @@ class Python4CPM:
         ACTION_PRERECONCILE,
         ACTION_RECONCILE,
     )
-    _SUCCESS_CODE = 0
+    _SUCCESS_CODE = 10
     _FAILED_RECOVERABLE_CODE = 81
     _FAILED_UNRECOVERABLE_CODE = 89
     _ENV_PREFIX = "PYTHON4CPM_"
     def __init__(self, name: str) -> None:
         self._name = name
-        args = self._get_args()
-        self._args = Args(**args)
+        self._args = self._get_args()
         self._logger = get_logger(
             self._name,
             self._args.logging,
@@ -36,8 +36,9 @@ class Python4CPM:
         self.log_info("Python4CPM.__init__: initiating...")
         self._log_args()
         self._verify_action()
-        secrets = self._get_secrets()
-        self._secrets = Secrets(**secrets)
+        self._secrets = self._get_secrets()
+        self._closed = False
+        atexit.register(self._on_exit)
     @property
     def args(self) -> Args:
@@ -75,19 +76,21 @@ class Python4CPM:
     def _get_args(cls) -> dict:
         args = {}
         for arg in Args.ARGS:
-            args[arg] = os.environ.get(cls._get_env_key(arg))
-        return args
+            _arg = os.environ.get(cls._get_env_key(arg))
+            args[arg] = _arg if _arg is not None else ""
+        return Args(**args)
     def _get_secrets(self) -> dict:
         secrets = {}
         for secret in Secrets.SECRETS:
-            secrets[secret] = os.environ.get(self._get_env_key(secret))
+            _secret = os.environ.get(self._get_env_key(secret))
+            secrets[secret] = _secret if _secret is not None else ""
             common_message = f"Python4CPM._get_secrets: {secret} ->"
             if secrets[secret]:
                 self.log_info(f"{common_message} [*******]")
             else:
                 self.log_info(f"{common_message} [NOT SET]")
-        return secrets
+        return Secrets(**secrets)
     def _verify_action(self) -> None:
         if self.args.action not in self._VALID_ACTIONS:
@@ -109,10 +112,19 @@ class Python4CPM:
         else:
             code = self._FAILED_UNRECOVERABLE_CODE
         self.log_error(f"Python4CPM.close_fail: closing with code {code}")
+        self._closed = True
         sys.exit(code)
     def close_success(self) -> None:
         self.log_info(
             f"Python4CPM.close_success: closing with code {self._SUCCESS_CODE}"
         )
+        self._closed = True
         sys.exit(self._SUCCESS_CODE)
+    def _on_exit(self):
+        if self._closed is False:
+            message = "Python4CPM._on_exit: no close signal called"
+            self.log_error(message)
+            sys.stderr.write(message)
+            sys.stderr.flush()

{python4cpm-1.0.19 → python4cpm-1.0.21/src/python4cpm.egg-info}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python4cpm
-Version: 1.0.19
+Version: 1.0.21
 Summary: Python for CPM
 Author-email: Gonzalo Atienza Rela <gonatienza@gmail.com>
 License: MIT License
@@ -25,7 +25,7 @@ License: MIT License
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
         THE SOFTWARE.
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Dynamic: license-file
@@ -40,29 +40,41 @@ This platform allows you to duplicate it multiple times, simply changing its set
 ### Preparing Python
-1. Install Python in CPM.  **Python must be installed for all users when running the install wizard**.
-2. Create a venv in CPM, by running `py -m venv c:\venv`.  Use the default location `c:\venv` or a custom one (e.g., `c:\my-venv-path`).
-3. Install `python4cpm` in your venv:
+1. Install Python in CPM.
+    - **Python must be installed for all users**.  Follow the custom install steps from the installation wizard to check the checkbox.
+3. Create a venv in CPM, by running `py -m venv c:\venv`.  If desired, use a custom location and adjust any future references.
+4. Install `python4cpm` in your venv:
     - If your CPM can connect to the internet, install with `c:\venv\Scripts\pip install python4cpm`.
     - If your CPM cannot connect to the internet:
-        - Download the latest `*.whl` file from the [pypi project files](https://pypi.org/project/python4cpm/#files).
+        - Download the latest `python4cpm-*.whl` file from the [pypi project files](https://pypi.org/project/python4cpm/#files).
         - Copy the file to CPM and extract to a temporary directory called `python4cpm-wheel`.
         - From the parent directory of `python4cpm-wheel` run `c:\venv\Scripts\pip install --no-index --find-links=.\python4cpm-wheel python4cpm`.
 ### Importing the platform
-1. Download the latest [Credential Management .NET SDK](https://community.cyberark.com/marketplace/s/#a3550000000EkA0AAK-a3950000000jjoOAAQ) and place its content in the bin folder of CPM (`C:\Program Files (x86)\CyberArk\Password Manager\bin`).
-2. Download the `python4cpm-platform.zip` asset from the [release](https://github.com/gonatienza/python4cpm/releases).
+#### If you are using CPM (SaaS or Self-Hosted):
+1. Download the latest [Credential Management .NET SDK](https://community.cyberark.com/marketplace/s/#a3550000000EkA0AAK-a3950000000jjoOAAQ) and place its content in the bin folder of CPM (`C:\Program Files (x86)\CyberArk\Password Manager\bin`).  The files for this may already be present.
+2. Download the `python4cpm-platform-*.zip` asset from the [release](https://github.com/gonatienza/python4cpm/releases).
 3. Import the platform zip file into Privilege Cloud/PVWA `(Administration -> Platform Management -> Import platform)`.
-4. Craft your python script and place it within the bin folder of CPM (`C:\Program Files (x86)\CyberArk\Password Manager\bin`).
+4. Craft your python script and place it within a folder in CPM (e.g., `C:\python4cpm-scripts`).
 5. Duplicate the imported platform in Privilege Cloud/PVWA `(Administration -> Platform Management -> Application -> Python for CPM)` and name it after your application (e.g., My App).
-6. Edit the duplicated platform and specify the path of your placed script in the bin folder of CPM, under `Target Account Platform -> Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonScriptPath -> Value` (e.g., `bin\myapp.py`).
-7. If you used a custom venv location, also update `Target Account Platform -> Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonExePath -> Value` with the custom path for the venv's `python.exe` file (e.g., `c:\my-venv-path\Scripts\python.exe`).
+6. Edit the duplicated platform and specify the path of your script, under `Target Account Platform -> Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonScriptPath -> Value` (e.g., `C:\python4cpm-scripts\myapp.py`).
+7. Also update `Target Account Platform -> Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonExePath -> Value` with the custom path for the venv's `python.exe` file (e.g., `c:\venv\Scripts\python.exe`).
 8. If you want to disable logging, update `Target Account Platform -> Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonLogging -> Value` to `no`.
 9. If you want to change the logging level to `debug`, update `Target Account Platform -> Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonLoggingLevel -> Value` to `debug`.
 10. For new applications repeat steps from 4 to 9.
+#### If you are using SRS (SaaS only):
+1. Download the `python4cpm-platform-*.zip` asset from the [release](https://github.com/gonatienza/python4cpm/releases).
+2. Import the platform zip file into Privilege Cloud `(Administration -> Platform Management -> Import platform)`.
+3. Craft your python script and place it within a folder in the Cloud Connector (where the SRS Management Agent runs) (e.g., `C:\python4cpm-scripts`).
+4. Duplicate the imported platform in Privilege Cloud/PVWA `(Administration -> Platform Management -> Application -> Python for CPM)` and name it after your application (e.g., My App).
+5. Edit the duplicated platform and specify the path of your script, under `Plugin Settings -> Additional Parameters -> PythonScriptPath` (e.g., `C:\python4cpm-scripts\myapp.py`).
+6. Also update `Plugin Settings -> Additional Parameters -> PythonExePath` with the custom path for the venv's `python.exe` file (e.g., `c:\venv\Scripts\python.exe`).
+7. If you want to disable logging, update `Plugin Settings -> Additional Parameters -> PythonLogging` to `no`.
+8. If you want to change the logging level to `debug`, update `Plugin Settings -> Additional Parameters -> PythonLoggingLevel -> Value` to `debug`.
+9. For new applications repeat steps from 3 to 8.
 ## Python Script
@@ -93,11 +105,12 @@ p4cpm.log_info("this is an info message") # logs info into Logs/ThirdParty/Pytho
 # Logging level -> Will only log debug messages if Automatic Platform Management -> Additional Policy Settings -> Parameters -> PythonLoggingLevel is set to debug (default is info)
 p4cpm.log_debug("this is an debug message") # logs info into Logs/ThirdParty/Python4CPM/MyApp.log if logging level is set to debug
-# Terminate signals -> ALWAYS use one of the following three signals to terminate the script
+# Terminate signals -> MUST use one of the following three signals to terminate the script:
 ## p4cpm.close_success() # terminate with success state
 ## p4cpm.close_fail() # terminate with recoverable failed state
 ## p4cpm.close_fail(unrecoverable=True) # terminate with unrecoverable failed state
-# If no signal is call, CPM will not know if the action was successful and display an error
+# When calling a signal sys.exit is invoked and the script is terminated.
+# If no signal is called, and the script finishes without any exception, it will behave like p4cpm.close_fail(unrecoverable=True) and log an error message.
 # Verification example -> verify the username and password are valid
@@ -171,7 +184,7 @@ if __name__ == "__main__":
 When doing `verify`, `change` or `reconcile` from Privilege Cloud/PVWA:
 1. Verify -> the sciprt will be executed once with the `p4cpm.args.action` as `Python4CPM.ACTION_VERIFY`.
 2. Change -> the sciprt will be executed twice, once with the action `p4cpm.args.action` as `Python4CPM.ACTION_LOGON` and once as `Python4CPM.ACTION_CHANGE`.
-    - If all actions are not terminated with `p4cpm.close_success()` the overall change will fail.
+    - If all actions are not terminated with `p4cpm.close_success()` and the scripts terminates without any exception, it defaults to a successful return.
 3. Reconcile -> the sciprt will be executed twice, once with the `p4cpm.args.action` as `Python4CPM.ACTION_PRERECONCILE` and once as `Python4CPM.ACTION_RECONCILE`.
     - If all actions are not terminated with `p4cpm.close_success()` the overall reconcile will fail.
 4. When `p4cpm.args.action` comes as `Python4CPM.ACTION_VERIFY`, `Python4CPM.ACTION_LOGON` or `Python4CPM.ACTION_PRERECONCILE`: `p4cpm.secrets.new_password.get()` will always return an empty string.