sfdc-agentforce-byoc-python-sdk 0.1.0__tar.gz

sfdc_agentforce_byoc_python_sdk-0.1.0/LICENSE

@@ -0,0 +1,206 @@
+Apache License Version 2.0
+
+Copyright (c) 2026 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.

sfdc_agentforce_byoc_python_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,439 @@
+Metadata-Version: 2.4
+Name: sfdc-agentforce-byoc-python-sdk
+Version: 0.1.0
+Summary: Python SDK for Agentforce BYOC (Bring Your Own Code)
+License: Apache-2.0
+License-File: LICENSE
+Keywords: agentforce,byoc,salesforce,sdk
+Requires-Python: >=3.11,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Requires-Dist: click (>=8.1.7,<9.0.0)
+Requires-Dist: pydantic (>=2.0.0,<3.0.0)
+Requires-Dist: pyyaml (>=6.0,<7.0)
+Project-URL: Homepage, https://github.com/salesforce/agentforce-byoc-python-sdk
+Project-URL: Repository, https://github.com/salesforce/agentforce-byoc-python-sdk
+Description-Content-Type: text/markdown
+
+# Agentforce BYOC Python SDK
+
+Python SDK for building custom agents with Agentforce BYOC (Bring Your Own Code).
+
+## Overview
+
+This SDK provides a straightforward way to build agents that integrate with Agentforce. Agents are simple Python functions that receive requests and return responses. The SDK handles relaying LLM calls through the Agentforce platform and structured logging.
+
+## Features
+
+- **Functional API**: Write agents as simple functions
+- **Agentforce BYOC runtime**: Relay LLM calls through the Agentforce platform
+- **LLM Gateway Integration**: Call language models from the Agentforce runtime
+- **Poetry Support**: Modern dependency management
+- **CLI Tools**: Commands for project initialization, testing, and deployment
+
+## Requirements
+
+- Python 3.11+
+- Poetry for dependency management
+
+## Installation
+
+### From PyPI (available once published)
+
+Once the package is published to PyPI, this is the official way to install the
+SDK and its `agentforce` CLI:
+
+```bash
+pip install sfdc-agentforce-byoc-python-sdk
+```
+
+### Development Setup
+
+1. Clone the repository:
+```bash
+git clone <repository-url>
+cd agentforce-byoc-python-sdk
+```
+
+2. Install dependencies:
+```bash
+make setup
+```
+
+3. Verify installation:
+```bash
+poetry run agentforce --version
+```
+
+## Quick Start
+
+### Create a New Agent
+
+```bash
+agentforce init my-agent
+cd my-agent
+poetry install
+```
+
+### Write Your Agent
+
+The generated `main.py` provides a working template. The entry point is a
+function named `function` decorated with the SDK's schema helpers:
+
+```python
+from agentforce_byoc import get_client, get_logger
+from agentforce_byoc.schema_utils import entry_func, requestSchema, responseSchema
+
+logger = get_logger(__name__)
+
+
+@entry_func
+@requestSchema(ExampleRequest)
+@responseSchema(ExampleResponse)
+def function(request: dict) -> dict:
+    """Entry point called by the Agentforce BYOC runtime."""
+    text = request.get("text", "")
+    if not text:
+        return {"result": "", "status": "error"}
+
+    # Relay a chat-generations call through the Agentforce Relay API. The
+    # tenant id, user id, and app context are read from the environment
+    # (SFDC_CORE_TENANT_ID / SFDC_USER_ID / SFDC_APP_CONTEXT), which the
+    # runtime injects.
+    client = get_client()
+    relay_response = client.call_llm_chat_generations(
+        parameter={"messages": [{"role": "user", "content": text}]},
+    )
+    return {"result": str(relay_response), "status": "success"}
+```
+
+The template's `main()` builds a sample request (with a `text` placeholder to
+fill in) and calls `function(...)` so you can test with `agentforce run`.
+
+### Test Your Agent
+
+Run against the Agentforce BYOC runtime (set auth + tenant + user + app context
+first — commands abort if unset):
+```bash
+export ORG_JWT_TOKEN=<your-org-jwt>
+export SFDC_CORE_TENANT_ID=core/<instance>-<fd>/<org-id>
+export SFDC_USER_ID=<user-id>
+export SFDC_APP_CONTEXT=<app-context>
+
+agentforce run main.py
+```
+
+### Package and Deploy
+
+```bash
+# Validate your agent
+agentforce validate .
+
+# Build end-to-end (validate -> run -> zip)
+agentforce package .
+
+# Register + upload to Agentforce BYOC in one step, then poll status
+# (set all four identity env vars first; required)
+export ORG_JWT_TOKEN=<jwt>
+export SFDC_CORE_TENANT_ID=core/<instance>-<fd>/<org-id>
+export SFDC_USER_ID=<user-id>
+export SFDC_APP_CONTEXT=<app-context>
+agentforce deploy --package-name "my-agent" --package-file my-agent-0.1.0.tar.gz
+agentforce deploy-status --package-name "my-agent"
+```
+
+## API Reference
+
+### `get_client() -> Client`
+
+Returns the singleton Client instance for relaying calls through the Agentforce Relay API.
+
+```python
+from agentforce_byoc import get_client
+
+client = get_client()
+response = client.call_llm_generations(
+    parameter={"prompt": "What is AI?"},
+)
+```
+
+The client exposes one method per Relay function:
+- `call_llm_generations(parameter)` — Relay function `llm`
+- `call_llm_chat_generations(parameter)` — Relay function `llm_chat`
+
+`parameter` is the raw request body and is passed through to the Relay API
+unchanged. The tenant id, user id, and app context are read from the
+environment (`SFDC_CORE_TENANT_ID` / `SFDC_USER_ID` / `SFDC_APP_CONTEXT`),
+which the runtime injects in the managed sandbox. The endpoint URL is
+`BYOC_PROXY_URL` as-is when it already ends in `/byoc/service` (as the runtime
+injects it); otherwise `/byoc/service` is appended to the `BYOC_PROXY_URL` base
+host (the same value `deploy` uses) or to `https://api.salesforce.com`.
+
+**Runtime Selection:**
+- **Agentforce BYOC runtime** (default): real Relay calls; org JWT from `ORG_JWT_TOKEN` (injected by the runtime)
+- **Mock mode**: `AGENTFORCE_BYOC_MOCK` is set (truthy); org JWT supplied by the author (`ORG_JWT_TOKEN`)
+
+### `get_logger(name: str) -> Logger`
+
+Returns a structured logger for your module.
+
+```python
+from agentforce_byoc import get_logger
+
+logger = get_logger(__name__)
+logger.info("Processing request", extra={"user_id": "123"})
+logger.error("Request failed", exc_info=True)
+```
+
+## State Management
+
+Use module-level variables to maintain state across requests:
+
+```python
+from agentforce_byoc import get_client, get_logger
+
+logger = get_logger(__name__)
+
+# Module-level state persists across function calls
+_request_count = 0
+_cache = {}
+
+def function(request: dict) -> dict:
+    global _request_count
+    _request_count += 1
+
+    query = request.get("query", "")
+
+    # Check cache
+    if query in _cache:
+        return {"response": _cache[query], "cached": True}
+
+    # Relay an LLM generations call
+    client = get_client()
+    response = client.call_llm_generations(
+        parameter={"prompt": query},
+    )
+
+    # Update cache
+    _cache[query] = response
+
+    return {
+        "response": response,
+        "cached": False,
+        "request_number": _request_count
+    }
+```
+
+## CLI Commands
+
+### `agentforce init [directory]`
+
+Initialize a new agent project.
+
+```bash
+agentforce init my-agent
+```
+
+### `agentforce run [entrypoint]`
+
+Run agent locally against the Agentforce BYOC runtime (requires the env vars).
+
+```bash
+export ORG_JWT_TOKEN=<your-org-jwt>
+export SFDC_CORE_TENANT_ID=core/<instance>-<fd>/<org-id>
+export SFDC_USER_ID=<user-id>
+export SFDC_APP_CONTEXT=<app-context>
+agentforce run main.py
+```
+
+### `agentforce validate [path]`
+
+Validate agent before deployment.
+
+```bash
+agentforce validate .
+```
+
+### `agentforce package [path]`
+
+Build end-to-end (validate → run → zip).
+
+```bash
+agentforce package .
+agentforce package --output my-agent.tar.gz
+```
+
+Auth/identity for `run`, `deploy`, and `deploy-status` come from environment
+variables — all four of `ORG_JWT_TOKEN`, `SFDC_CORE_TENANT_ID`
+(`core/<instance>-<fd>/<org-id>`), `SFDC_USER_ID`, and `SFDC_APP_CONTEXT`. `run`
+relays through the Agentforce service and `deploy`/`deploy-status` call the BYOC
+API; both send the user id and app context as `x-sfdc-user-id` /
+`x-sfdc-app-context`. If a required var is unset, the command aborts with an
+`export` instruction. (They are not prompted: an org JWT exceeds the terminal's
+~1024-char line limit, so a typed prompt can't accept it.)
+
+### `agentforce deploy`
+
+Register and upload a packaged agent to Agentforce BYOC. A single
+`POST /byoc/upload/request` registers the package metadata (size, entry point,
+max live duration) **and** returns a presigned upload URL; the CLI then PUTs the
+archive to that URL.
+
+```bash
+export ORG_JWT_TOKEN=<jwt>
+export SFDC_CORE_TENANT_ID=core/<instance>-<fd>/<org-id>
+export SFDC_USER_ID=<user-id>
+export SFDC_APP_CONTEXT=<app-context>
+agentforce deploy --package-name "my-agent" --package-file my-agent-0.1.0.tar.gz
+```
+
+Options: `--package-name` and `--package-file` (required), plus `--entry-point`
+(default `main.py`), `--version` (default `1.0`), and `--max-live-duration`
+(default `300` seconds).
+
+### `agentforce deploy-status`
+
+Poll deployment status (read-only). Calls `GET /byoc/upload/status` and reports
+`registrationStatus` (is the package registered) and `uploadStatus` (has the
+archive been uploaded). Registration happens during `deploy`; this command never
+writes.
+
+```bash
+agentforce deploy-status --package-name "my-agent" --version 1.0
+```
+
+## Architecture
+
+### Agent Interface
+
+Agents are implemented as simple functions:
+
+```python
+def function(request: dict) -> dict:
+    # Your code
+    return response
+```
+
+The BYOC runtime calls this function for each request. The function receives a dictionary and returns a dictionary response
+
+### Runtime Selection
+
+The SDK supports two runtimes, selected on first `get_client()` call:
+
+1. **Agentforce BYOC Runtime** (default)
+   - Real Relay API calls authenticated with the org JWT
+   - Org JWT read from `ORG_JWT_TOKEN` (injected by the runtime)
+   - Tenant id, user id, and app context read from `SFDC_CORE_TENANT_ID` /
+     `SFDC_USER_ID` / `SFDC_APP_CONTEXT` (injected by the runtime); endpoint
+     URL from `BYOC_PROXY_URL` (as-is if it ends in `/byoc/service`, else
+     with `/byoc/service` appended), else production + `/byoc/service`
+
+2. **Mock Mode**: `AGENTFORCE_BYOC_MOCK` env var is set (truthy)
+   - Same relay behavior, with the org JWT supplied by the author
+   - JWT from the `MockRelayGatewayClient(org_jwt=...)` arg or `ORG_JWT_TOKEN`
+   - Selected via the env var (there is no CLI flag for it)
+
+### Code Portability
+
+Agent code works across both runtimes without modification:
+
+```python
+# This code works in both runtimes
+def function(request: dict) -> dict:
+    client = get_client()  # Selects runtime
+    return client.call_llm_generations(...)
+```
+
+## Examples
+
+The `examples/` directory contains working examples:
+
+- **01_basic_agent.py** - Minimal functional agent
+- **02_llm_agent.py** - LLM Gateway integration
+- **03_sentiment_analysis.py** - Sentiment analysis use case
+- **04_stateful_agent.py** - State management patterns
+
+Run any example directly. Examples that call the relay need `ORG_JWT_TOKEN`,
+`SFDC_CORE_TENANT_ID`, `SFDC_USER_ID`, and `SFDC_APP_CONTEXT` exported;
+`01_basic_agent.py` does not call the relay and runs without credentials.
+
+```bash
+export ORG_JWT_TOKEN=<your-org-jwt>
+export SFDC_CORE_TENANT_ID=core/<instance>-<fd>/<org-id>
+export SFDC_USER_ID=<user-id>
+export SFDC_APP_CONTEXT=<app-context>
+python examples/01_basic_agent.py
+python examples/02_llm_agent.py
+python examples/03_sentiment_analysis.py
+```
+
+See [examples/README.md](examples/README.md) for detailed documentation.
+
+## Development
+
+### Project Structure
+
+```
+agentforce-byoc-python-sdk/
+├── agentforce_byoc/          # Main package
+│   ├── client.py             # Client with runtime selection
+│   ├── _http.py              # Stdlib HTTP helper (preserves header casing)
+│   ├── deploy_client.py      # /byoc/upload/request + upload/status client
+│   ├── runtime/              # Runtime providers
+│   │   ├── mock_runtime.py        # Mock provider
+│   │   ├── agentforce_runtime.py  # Agentforce provider (default)
+│   │   └── base.py                # Base provider interface
+│   ├── gateway/              # Relay gateway clients
+│   │   ├── relay_client.py        # Agentforce relay client
+│   │   ├── mock_relay_client.py   # Mock relay client
+│   │   └── base.py                # Base interface
+│   ├── schema_utils/         # entry_func / requestSchema / responseSchema
+│   ├── logging/              # Structured logging
+│   ├── cli/                  # CLI commands
+│   └── templates/            # Project templates
+├── examples/                 # Working examples
+├── tests/                    # Test suite
+├── pyproject.toml            # Poetry configuration
+└── README.md                 # This file
+```
+
+### Running Tests
+
+```bash
+poetry run pytest
+poetry run pytest --cov=agentforce_byoc
+```
+
+### Code Quality
+
+```bash
+make format   # black + isort
+make lint     # pre-commit: black, isort, ruff, codespell, license header, mypy
+```
+
+## Contributing
+
+Contributions are welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for setup, the
+development workflow, how to write tests, and the contributor/reviewer/trusted-committer
+roles. Architecture and design notes live in [ARCHITECTURE.md](ARCHITECTURE.md).
+
+## Support
+
+- **Questions / discussion**: start a [GitHub Discussion](https://github.com/salesforce/agentforce-byoc-python-sdk/discussions).
+- **Bugs / feature requests**: file a [GitHub Issue](https://github.com/salesforce/agentforce-byoc-python-sdk/issues).
+- **Security vulnerabilities**: follow [SECURITY.md](SECURITY.md) — please don't open a public issue for security reports.
+
+## License & Terms of Use
+
+This project is licensed under the [Apache License 2.0](LICENSE).
+
+Use of this project with Salesforce is subject to the [Terms of Use](TERMS_OF_USE.md).
+