salesforce-data-customcode 0.1.0__tar.gz

salesforce_data_customcode-0.1.0/LICENSE.txt

@@ -0,0 +1,206 @@
+Apache License Version 2.0
+
+Copyright (c) 2025 Salesforce, Inc.
+All rights reserved.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed 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 CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

salesforce_data_customcode-0.1.0/PKG-INFO

@@ -0,0 +1,159 @@
+Metadata-Version: 2.3
+Name: salesforce-data-customcode
+Version: 0.1.0
+Summary: Data Cloud Custom Code SDK
+License: Apache-2.0
+Requires-Python: >=3.10,<3.12
+Classifier: Development Status :: 4 - Beta
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: click (>=8.1.8,<9.0.0)
+Requires-Dist: loguru (>=0.7.3,<0.8.0)
+Requires-Dist: numpy
+Requires-Dist: pandas
+Requires-Dist: pydantic (>=1.8.2,<3.0.0)
+Requires-Dist: pyspark
+Requires-Dist: pyyaml (>=6.0,<7.0)
+Requires-Dist: salesforce-cdp-connector
+Requires-Dist: setuptools_scm (>=7.1.0,<8.0.0)
+Description-Content-Type: text/markdown
+
+# Data Cloud Custom Code SDK
+
+<img src="https://img.shields.io/badge/version-0.1.0-blue" alt="license">
+
+This package provides a development kit for creating custom data transformations in [Data Cloud](https://www.salesforce.com/data/). It allows you to write your own data processing logic in Python while leveraging Data Cloud's infrastructure for data access and running data transformations, mapping execution into Data Cloud data structures like [Data Model Objects](https://help.salesforce.com/s/articleView?id=data.c360_a_data_model_objects.htm&type=5) and [Data Lake Objects](https://help.salesforce.com/s/articleView?id=sf.c360_a_data_lake_objects.htm&language=en_US&type=5).
+
+More specifically, this codebase gives you ability to test code locally before pushing to Data Cloud's remote execution engine, greatly reducing how long it takes to develop.
+
+Use of this project with Salesforce is subject to the [TERMS OF USE](./TERMS_OF_USE.md)
+
+## Installation
+The SDK can be downloaded directly from PyPI with `pip`:
+```
+pip install salesforce-data-customcode
+```
+
+You can verify it was properly installed via CLI:
+```
+datacustomcode version
+```
+
+## Development Setup
+We offer two built-in development interfaces: `devcontainers` and Jupyter, but you can set up any tool you would like manually.
+
+To get started, use the CLI to initialize a new development environment:
+```
+datacustomcode init [DIRECTORY TO DUMP NEW REPO]
+```
+
+This will yield all necessary files to get started:
+```
+.
+├── Dockerfile
+├── README.md
+├── requirements.txt
+├── requirements-dev.txt
+├── payload
+│   ├── config.json
+│   ├── entrypoint.py
+├── jupyterlab.sh
+└── requirements.txt
+```
+* `Dockerfile` <span style="color:grey;font-style:italic;">(Do not update)</span> – Development container emulating the remote execution environment.
+* `requirements-dev.txt` <span style="color:grey;font-style:italic;">(Do not update)</span> – These are the dependencies for the development environment.
+* `jupyterlab.sh` <span style="color:grey;font-style:italic;">(Do not update)</span> – Helper script for setting up Jupyter.
+* `requirements.txt` – Here you define the requirements that you will need remotely
+* `payload` – This folder will be compressed and deployed to the remote execution environment.
+  * `config.json` – This config defines permissions on the back and can be generated programmatically with `scan` CLI method.
+  * `entrypoint.py` – The script that defines the data transformation logic.
+
+## API
+
+You entry point script will define logic using the `Client` object which wraps data access layers.
+
+You should only need the following methods:
+* `read_dlo(name)` – Read from a Data Lake Object by name
+* `read_dmo(name)` – Read from a Data Model Object by name
+* `write_to_dlo(name, spark_dataframe, write_mode)` – Write to a Data Model Object by name with a Spark dataframe
+* `write_to_dmo(name, spark_dataframe, write_mode)` – Write to a Data Lake Object by name with a Spark dataframe
+
+For example:
+```
+from datacustomcode import Client
+
+client = Client()
+
+sdf = client.read_dlo('my_DLO')
+# some transformations
+# ...
+client.write_to_dlo('output_DLO')
+```
+
+
+> [!WARNING]
+> Currently we only support reading from DMOs and writing to DMOs or reading from DLOs and writing to DLOs, but they cannot mix.
+
+
+## CLI
+
+The Data Cloud Custom Code SDK provides a command-line interface (CLI) with the following commands:
+
+### Global Options
+- `--debug`: Enable debug-level logging
+
+### Commands
+
+#### `datacustomcode version`
+Display the current version of the package.
+
+#### `datacustomcode configure`
+Configure credentials for connecting to Data Cloud.
+
+Options:
+- `--profile TEXT`: Credential profile name (default: "default")
+- `--username TEXT`: Salesforce username
+- `--password TEXT`: Salesforce password
+- `--client-id TEXT`: Connected App Client ID
+- `--client-secret TEXT`: Connected App Client Secret
+- `--login-url TEXT`: Salesforce login URL
+
+#### `datacustomcode deploy`
+Deploy a transformation job to Data Cloud.
+
+Options:
+- `--profile TEXT`: Credential profile name (default: "default")
+- `--path TEXT`: Path to the code directory (default: ".")
+- `--name TEXT`: Name of the transformation job [required]
+- `--version TEXT`: Version of the transformation job (default: "0.0.1")
+- `--description TEXT`: Description of the transformation job (default: "")
+
+#### `datacustomcode init`
+Initialize a new development environment with a template.
+
+Argument:
+- `DIRECTORY`: Directory to create project in (default: ".")
+
+#### `datacustomcode scan`
+Scan a Python file to generate a Data Cloud configuration.
+
+Argument:
+- `FILENAME`: Python file to scan
+
+Options:
+- `--config TEXT`: Path to save the configuration file (default: same directory as FILENAME)
+- `--dry-run`: Preview the configuration without saving to a file
+
+#### `datacustomcode run`
+Run an entrypoint file locally for testing.
+
+Argument:
+- `ENTRYPOINT`: Path to entrypoint Python file
+
+Options:
+- `--config-file TEXT`: Path to configuration file
+- `--dependencies TEXT`: Additional dependencies (can be specified multiple times)
+

salesforce_data_customcode-0.1.0/README.md

@@ -0,0 +1,135 @@
+# Data Cloud Custom Code SDK
+
+<img src="https://img.shields.io/badge/version-0.1.0-blue" alt="license">
+
+This package provides a development kit for creating custom data transformations in [Data Cloud](https://www.salesforce.com/data/). It allows you to write your own data processing logic in Python while leveraging Data Cloud's infrastructure for data access and running data transformations, mapping execution into Data Cloud data structures like [Data Model Objects](https://help.salesforce.com/s/articleView?id=data.c360_a_data_model_objects.htm&type=5) and [Data Lake Objects](https://help.salesforce.com/s/articleView?id=sf.c360_a_data_lake_objects.htm&language=en_US&type=5).
+
+More specifically, this codebase gives you ability to test code locally before pushing to Data Cloud's remote execution engine, greatly reducing how long it takes to develop.
+
+Use of this project with Salesforce is subject to the [TERMS OF USE](./TERMS_OF_USE.md)
+
+## Installation
+The SDK can be downloaded directly from PyPI with `pip`:
+```
+pip install salesforce-data-customcode
+```
+
+You can verify it was properly installed via CLI:
+```
+datacustomcode version
+```
+
+## Development Setup
+We offer two built-in development interfaces: `devcontainers` and Jupyter, but you can set up any tool you would like manually.
+
+To get started, use the CLI to initialize a new development environment:
+```
+datacustomcode init [DIRECTORY TO DUMP NEW REPO]
+```
+
+This will yield all necessary files to get started:
+```
+.
+├── Dockerfile
+├── README.md
+├── requirements.txt
+├── requirements-dev.txt
+├── payload
+│   ├── config.json
+│   ├── entrypoint.py
+├── jupyterlab.sh
+└── requirements.txt
+```
+* `Dockerfile` <span style="color:grey;font-style:italic;">(Do not update)</span> – Development container emulating the remote execution environment.
+* `requirements-dev.txt` <span style="color:grey;font-style:italic;">(Do not update)</span> – These are the dependencies for the development environment.
+* `jupyterlab.sh` <span style="color:grey;font-style:italic;">(Do not update)</span> – Helper script for setting up Jupyter.
+* `requirements.txt` – Here you define the requirements that you will need remotely
+* `payload` – This folder will be compressed and deployed to the remote execution environment.
+  * `config.json` – This config defines permissions on the back and can be generated programmatically with `scan` CLI method.
+  * `entrypoint.py` – The script that defines the data transformation logic.
+
+## API
+
+You entry point script will define logic using the `Client` object which wraps data access layers.
+
+You should only need the following methods:
+* `read_dlo(name)` – Read from a Data Lake Object by name
+* `read_dmo(name)` – Read from a Data Model Object by name
+* `write_to_dlo(name, spark_dataframe, write_mode)` – Write to a Data Model Object by name with a Spark dataframe
+* `write_to_dmo(name, spark_dataframe, write_mode)` – Write to a Data Lake Object by name with a Spark dataframe
+
+For example:
+```
+from datacustomcode import Client
+
+client = Client()
+
+sdf = client.read_dlo('my_DLO')
+# some transformations
+# ...
+client.write_to_dlo('output_DLO')
+```
+
+
+> [!WARNING]
+> Currently we only support reading from DMOs and writing to DMOs or reading from DLOs and writing to DLOs, but they cannot mix.
+
+
+## CLI
+
+The Data Cloud Custom Code SDK provides a command-line interface (CLI) with the following commands:
+
+### Global Options
+- `--debug`: Enable debug-level logging
+
+### Commands
+
+#### `datacustomcode version`
+Display the current version of the package.
+
+#### `datacustomcode configure`
+Configure credentials for connecting to Data Cloud.
+
+Options:
+- `--profile TEXT`: Credential profile name (default: "default")
+- `--username TEXT`: Salesforce username
+- `--password TEXT`: Salesforce password
+- `--client-id TEXT`: Connected App Client ID
+- `--client-secret TEXT`: Connected App Client Secret
+- `--login-url TEXT`: Salesforce login URL
+
+#### `datacustomcode deploy`
+Deploy a transformation job to Data Cloud.
+
+Options:
+- `--profile TEXT`: Credential profile name (default: "default")
+- `--path TEXT`: Path to the code directory (default: ".")
+- `--name TEXT`: Name of the transformation job [required]
+- `--version TEXT`: Version of the transformation job (default: "0.0.1")
+- `--description TEXT`: Description of the transformation job (default: "")
+
+#### `datacustomcode init`
+Initialize a new development environment with a template.
+
+Argument:
+- `DIRECTORY`: Directory to create project in (default: ".")
+
+#### `datacustomcode scan`
+Scan a Python file to generate a Data Cloud configuration.
+
+Argument:
+- `FILENAME`: Python file to scan
+
+Options:
+- `--config TEXT`: Path to save the configuration file (default: same directory as FILENAME)
+- `--dry-run`: Preview the configuration without saving to a file
+
+#### `datacustomcode run`
+Run an entrypoint file locally for testing.
+
+Argument:
+- `ENTRYPOINT`: Path to entrypoint Python file
+
+Options:
+- `--config-file TEXT`: Path to configuration file
+- `--dependencies TEXT`: Additional dependencies (can be specified multiple times)