harness-sdk 1.0.0__tar.gz

harness_sdk-1.0.0/LICENSE.md

@@ -0,0 +1,202 @@
+
+                                 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 2026 Harness, Inc.
+
+   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.

harness_sdk-1.0.0/NOTICE.md

@@ -0,0 +1,28 @@
+# NOTICE
+
+## harness-sdk
+
+Copyright 2026 Harness, Inc.
+
+Licensed under the Apache License, Version 2.0.
+See [LICENSE.md](LICENSE.md) for the full license text.
+
+## Third-party software
+
+This product bundles portions of the following third-party works under the
+Apache License, Version 2.0. Source is vendored from the OpenTelemetry Python
+Contrib repository at build time and distributed under the `opentelemetry`
+namespace in release artifacts.
+
+### OpenTelemetry Python Contrib — GenAI instrumentation
+
+Copyright The OpenTelemetry Authors
+
+Components included in distributions:
+
+- `opentelemetry.util.genai` (from `opentelemetry-util-genai`)
+- `opentelemetry.instrumentation.anthropic` (from `opentelemetry-instrumentation-anthropic`)
+- `opentelemetry.instrumentation.openai_v2` (from `opentelemetry-instrumentation-openai-v2`)
+
+- Source: https://github.com/open-telemetry/opentelemetry-python-contrib
+- License: Apache License, Version 2.0 (see [LICENSE.md](LICENSE.md))

harness_sdk-1.0.0/PKG-INFO

@@ -0,0 +1,318 @@
+Metadata-Version: 2.4
+Name: harness-sdk
+Version: 1.0.0
+Summary: Harness Python SDK with instrumentation and plugin architecture
+License-Expression: Apache-2.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+License-File: NOTICE.md
+Requires-Dist: opentelemetry-api==1.41.1
+Requires-Dist: opentelemetry-exporter-otlp==1.41.1
+Requires-Dist: opentelemetry-instrumentation==0.62b1
+Requires-Dist: opentelemetry-instrumentation-aiohttp-client==0.62b1
+Requires-Dist: opentelemetry-instrumentation-botocore==0.62b1
+Requires-Dist: opentelemetry-instrumentation-wsgi==0.62b1
+Requires-Dist: opentelemetry-instrumentation-fastapi==0.62b1
+Requires-Dist: opentelemetry-instrumentation-flask==0.62b1
+Requires-Dist: opentelemetry-instrumentation-mysql==0.62b1
+Requires-Dist: opentelemetry-instrumentation-psycopg2==0.62b1
+Requires-Dist: opentelemetry-instrumentation-requests==0.62b1
+Requires-Dist: opentelemetry-instrumentation-httpx==0.62b1
+Requires-Dist: opentelemetry-instrumentation-grpc==0.62b1
+Requires-Dist: opentelemetry-instrumentation-django==0.62b1
+Requires-Dist: opentelemetry-instrumentation-mcp==0.60.0
+Requires-Dist: opentelemetry-semantic-conventions-ai<0.6.0,>=0.5.1
+Requires-Dist: opentelemetry-propagator-b3==1.41.1
+Requires-Dist: opentelemetry-proto==1.41.1
+Requires-Dist: opentelemetry-sdk==1.41.1
+Requires-Dist: opentelemetry-util-http==0.62b1
+Requires-Dist: google>=3.0.0
+Requires-Dist: pyyaml
+Requires-Dist: protobuf
+Requires-Dist: psutil
+Requires-Dist: distro
+Requires-Dist: setuptools
+Requires-Dist: jaraco.text
+Requires-Dist: platformdirs
+Provides-Extra: anthropic
+Requires-Dist: anthropic>=0.34.0; extra == "anthropic"
+Provides-Extra: openai
+Requires-Dist: openai>=1.40.0; extra == "openai"
+Provides-Extra: litellm
+Requires-Dist: litellm>=1.60.0; extra == "litellm"
+Provides-Extra: dev
+Requires-Dist: pytest==7.4.3; extra == "dev"
+Requires-Dist: pytest-cov==3.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: pytest-django==4.12.0; extra == "dev"
+Requires-Dist: flask==3.1.3; extra == "dev"
+Requires-Dist: Werkzeug==3.1.8; extra == "dev"
+Requires-Dist: aiohttp; extra == "dev"
+Requires-Dist: fastapi>=0.75.0; extra == "dev"
+Requires-Dist: psycopg2-binary; extra == "dev"
+Requires-Dist: mysql-connector-python==8.0.26; extra == "dev"
+Requires-Dist: boto3==1.35.43; extra == "dev"
+Requires-Dist: moto==3.0.3; extra == "dev"
+Requires-Dist: docker; extra == "dev"
+Requires-Dist: httpx; extra == "dev"
+Requires-Dist: Django==5.2.13; extra == "dev"
+Requires-Dist: anthropic>=0.34.0; extra == "dev"
+Requires-Dist: openai>=1.40.0; extra == "dev"
+Requires-Dist: litellm>=1.60.0; extra == "dev"
+Requires-Dist: grpcio; extra == "dev"
+Dynamic: license-file
+Dynamic: requires-python
+
+# harness-sdk (otel-python-sdk)
+
+Generic Python agent SDK with OpenTelemetry instrumentation and a plugin architecture.
+
+## Local development
+
+```bash
+bash scripts/fetch-vendor.sh
+pip install -e ".[dev,anthropic,openai,litellm]"
+./scripts/run-unit-tests.sh
+```
+
+Environment variables for SDK configuration use the `HA_` prefix (for example `HA_SERVICE_NAME`, `HA_REPORTING_ENDPOINT`).
+
+### Integration tests (MySQL / PostgreSQL)
+
+```bash
+cd test/externalServices && docker compose up -d --wait
+cd ../..
+RUN_SDK_INTEGRATION_TESTS=1 ./scripts/run-unit-tests.sh
+```
+
+## CI
+
+GitHub Actions workflows (public repo, `ubuntu-latest`):
+
+| Workflow | Trigger | Purpose |
+|----------|---------|---------|
+| [pr_build.yaml](.github/workflows/pr_build.yaml) | PR + push to `main` | Build manylinux wheels, lint, pytest (with Docker for DB tests) |
+| [publish.yaml](.github/workflows/publish.yaml) | Tag `v*.*.*` | Build release artifacts and publish to PyPI / TestPyPI |
+| [staticanalysis.yaml](.github/workflows/staticanalysis.yaml) | PR, `main`, weekly | Trivy filesystem scan |
+
+## Publishing to PyPI
+
+1. Configure [trusted publishing](https://docs.pypi.org/trusted-publishers/) on PyPI (and TestPyPI for RCs):
+   - **PyPI**: environment `pypi`, workflow `publish.yaml`, job `publish-pypi`
+   - **TestPyPI**: environment `testpypi`, workflow `publish.yaml`, job `publish-testpypi`
+2. Create and push a release tag:
+   ```bash
+   git tag v0.1.0
+   git push origin v0.1.0
+   ```
+3. Release candidates (`v1.0.0-rc.1`) publish to **TestPyPI** only; stable tags publish to **PyPI**.
+
+Version is taken from the tag (`v1.2.3` → `1.2.3`) via `scripts/build.sh`, which updates `src/harness_sdk/version.py` and `pyproject.toml`.
+
+## Installing
+
+### From PyPI (stable releases)
+
+```bash
+pip install harness-sdk
+```
+
+Optional instrumentation extras:
+
+```bash
+pip install "harness-sdk[anthropic,openai,litellm]"
+```
+
+### From TestPyPI (release candidates)
+
+Tags containing `-rc` (for example `v1.0.0-rc.1`) are published only to [TestPyPI](https://test.pypi.org/project/harness-sdk/). Use TestPyPI as the primary index and PyPI as a fallback so dependencies that are not on TestPyPI still resolve:
+
+```bash
+pip install \
+  --index-url https://test.pypi.org/simple/ \
+  --extra-index-url https://pypi.org/simple/ \
+  "harness-sdk==1.0.0-rc.1"
+```
+
+With optional extras:
+
+```bash
+pip install \
+  --index-url https://test.pypi.org/simple/ \
+  --extra-index-url https://pypi.org/simple/ \
+  "harness-sdk[anthropic,openai,litellm]==1.0.0-rc.1"
+```
+
+Pin the version to the RC you want (see [published files](https://test.pypi.org/project/harness-sdk/#history) on TestPyPI). The version string matches the tag without the leading `v` (tag `v1.0.0-rc.1` → `1.0.0-rc.1`). In a virtualenv or `requirements.txt`, the same flags apply:
+
+```text
+--index-url https://test.pypi.org/simple/
+--extra-index-url https://pypi.org/simple/
+harness-sdk==1.0.0-rc.1
+```
+
+After install, import and auto-instrument work the same as a PyPI release:
+
+```python
+from harness_sdk.agent import Agent
+```
+
+```bash
+harness-instrument python app.py
+```
+
+## Usage
+
+```python
+from harness_sdk.agent import Agent
+
+agent = Agent()
+agent.instrument()
+```
+
+Auto-instrumentation:
+
+```bash
+export HA_CONFIG_FILE=/path/to/config.yaml
+harness-instrument python app.py
+```
+
+## Plugins
+
+The SDK loads extensions via [setuptools entry points](https://setuptools.pypa.io/en/latest/userguide/entry_point.html). Each plugin has a **name** (the entry-point key). Names are listed in config or environment variables; only installed plugins are loaded, in the order you configure.
+
+| Type | Entry-point group | Config key / env |
+|------|-------------------|------------------|
+| Control | `harness_sdk_control_plugin` | `plugins.control` / `HA_CONTROL_PLUGINS` |
+| Observability | `harness_sdk_observability_plugin` | `plugins.observability` / `HA_OBSERVABILITY_PLUGINS` |
+
+Built-in observability plugins (shipped with `harness-sdk`):
+
+- `builtin_pipeline` — OTLP export, sampling, exclusion processors
+- `builtin_span_attributes` — service name and configured span attributes
+
+Example `agent-config.yaml`:
+
+```yaml
+service_name: my-service
+reporting:
+  endpoint: http://localhost:4318
+plugins:
+  control:
+    - my_policy          # order matters: first plugin runs first
+  observability:
+    - builtin_pipeline
+    - builtin_span_attributes
+    - my_exporter        # custom plugin after builtins
+```
+
+Or via environment (comma-separated, same order semantics):
+
+```bash
+export HA_CONTROL_PLUGINS=my_policy
+export HA_OBSERVABILITY_PLUGINS=builtin_pipeline,builtin_span_attributes,my_exporter
+```
+
+### Create a control plugin
+
+Control plugins evaluate HTTP/gRPC ingress and GenAI spans. They return a `ControlResult` (block, headers, span attributes, etc.). Plugins run in config order; the chain stops when one returns `block=True`.
+
+1. **Implement the plugin** in your package (see `harness_sdk.plugins.control.ControlPlugin`):
+
+```python
+# my_company_policy/plugin.py
+from typing import Any
+from opentelemetry.trace import Span
+from harness_sdk.plugins.control import ControlResult, ControlPlugin
+
+
+class MyPolicyPlugin:
+    name = "my_policy"
+    provides_blocking = True  # set True if this plugin can block requests
+
+    def on_init(self, config: Any) -> None:
+        self._config = config
+
+    def evaluate(
+        self, span: Span, url: str, headers: dict, body, is_grpc: bool
+    ) -> ControlResult:
+        result = ControlResult()
+        # result.block = True
+        # result.response_status_code = 403
+        return result
+
+    def evaluate_agent_span(self, span: Span, body: str = "") -> ControlResult:
+        return ControlResult()
+
+    def shutdown(self) -> None:
+        pass
+
+
+def factory(config: Any) -> ControlPlugin:
+    return MyPolicyPlugin()
+```
+
+2. **Register the entry point** in your package `pyproject.toml`:
+
+```toml
+[project.entry-points.harness_sdk_control_plugin]
+my_policy = "my_company_policy.plugin:factory"
+```
+
+(Equivalent in `setup.py`: `entry_points={'harness_sdk_control_plugin': ['my_policy = ...']}`.)
+
+3. **Install** your package in the same environment as the app (`pip install my-company-policy`).
+
+4. **Enable** the plugin by name in config or `HA_CONTROL_PLUGINS` (see above).
+
+For tests or one-off wiring you can also call `agent.register_control_plugin(plugin)` after `Agent()` is constructed.
+
+Reference implementation: the Traceable agent ships a control plugin as `traceable` (`traceableai.plugins.traceable_control:factory`).
+
+### Create an observability plugin
+
+Observability plugins contribute OpenTelemetry `SpanProcessor` instances to the tracer provider. Processors are registered in config order (each plugin’s `create_span_processors` may return multiple processors).
+
+1. **Implement the plugin** (see `harness_sdk.plugins.observability.ObservabilityPlugin`):
+
+```python
+# my_company_telemetry/plugin.py
+from typing import Any, List
+from opentelemetry.sdk.trace import SpanProcessor
+from opentelemetry.sdk.trace.export import ConsoleSpanExporter, SimpleSpanProcessor
+
+
+class MyExporterPlugin:
+    name = "my_exporter"
+    priority = 300  # informational; ordering is driven by config list
+
+    def on_init(self, config: Any) -> None:
+        self._config = config
+
+    def create_span_processors(self, config: Any) -> List[SpanProcessor]:
+        return [SimpleSpanProcessor(ConsoleSpanExporter())]
+
+    def shutdown(self) -> None:
+        pass
+
+
+def factory(config: Any) -> MyExporterPlugin:
+    return MyExporterPlugin()
+```
+
+2. **Register the entry point**:
+
+```toml
+[project.entry-points.harness_sdk_observability_plugin]
+my_exporter = "my_company_telemetry.plugin:factory"
+```
+
+3. **Install** your package and **enable** it under `plugins.observability` or `HA_OBSERVABILITY_PLUGINS`.
+
+If you omit observability plugins entirely, the SDK defaults to `builtin_pipeline` and `builtin_span_attributes`. Custom plugins typically keep those builtins and append your entry after them.
+
+Reference implementations in this repo:
+
+- `harness_sdk.plugins.builtin.pipeline`
+- `harness_sdk.plugins.builtin.span_attributes`