Metadata-Version: 2.2
Name: cogplane
Version: 0.1.1
Summary: Signed, fail-open evidence capture for governed AI agents
Author-email: CogPlane <info@cogplane.com>
Maintainer-email: CogPlane <info@cogplane.com>
License:                                  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 CogPlane
        
           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.
        
Project-URL: Homepage, https://cogplane.com
Project-URL: Documentation, https://cogplane.com/ui#guide
Project-URL: Repository, https://github.com/trapti25mishra-ctrl/CogPlane
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.31.0

# CogPlane Python SDK

Licensed under Apache-2.0. The license applies to this distributable SDK only,
not to the CogPlane server or the rest of the repository.

Send HMAC-authenticated agent evidence to CogPlane without placing CogPlane in the agent's
critical execution path. The default client queues records locally and fails
open if evidence delivery is temporarily unavailable.

## Five-minute onboarding

### 1. Install

```powershell
python -m pip install cogplane
```

### 2. Get an ingestion key

An organization administrator opens **Settings → SDK ingestion identity**,
selects the exact workspace, and chooses **Issue ingestion key**. The returned
`cgp_ingest_` value is shown once and carries only `cognition.write`; save it
directly in the workload secret manager. Revoking that ingestion identity
disables its service actor and all of its API keys.

For operator-created organizations, an operator can instead create the tenant:

```powershell
$headers = @{
  Authorization = "Bearer $env:COGPLANE_ADMIN_TOKEN"
  "Content-Type" = "application/json"
}
$body = '{"org_id":"acme","project_id":"invoice-pilot","env":"prod"}'
Invoke-RestMethod -Method Post -Uri "$env:COGPLANE_URL/admin/tenants" `
  -Headers $headers -Body $body
```

Copy the returned `ingest_key` into a secret manager and expose it to the agent
as `COGPLANE_INGEST_KEY`. When `COGPLANE_PUBLIC_URL` and the RBAC store are
available, tenant creation also provisions one `sdk-default` service actor with
only `cognition.write`. Its one-time `cpk_` API key is carried inside the
returned ingestion key; it is not exposed as a second top-level secret. The
non-secret `sdk_actor` response field identifies the actor and its permission.

An ingestion key starts with `cgp_ingest_`. The complete token contains both
the tenant signing secret and least-privilege RBAC actor key in encoded, not
encrypted, form. Treat it exactly like a password: never put it in source code,
logs, screenshots, tickets, or browser storage.

`GET /admin/tenants/ingest-key` deliberately remains side-effect-free and
returns a legacy secret-only token; it does not create or return an actor key.
On an RBAC-enabled server, obtain the complete one-key token from org-admin
Settings or `POST /admin/tenants`. The legacy operator-only recovery path may
pair a reissued token with a key from `POST /admin/rbac/actors` using
`CogPlane(key=..., api_key=...)`.

### 3. Record an event

```python
import os
from cogplane import CogPlane

cog = CogPlane(
    key=os.environ["COGPLANE_INGEST_KEY"],
    run_id=os.environ.get("COGPLANE_RUN_ID"),  # optional cross-restart continuity
)
cog.record(agent="invoice-bot", input="Approve invoice 42?", output="Escalated")
cog.flush(timeout=5)
```

`run_id` is a customer-chosen grouping label, not a server-side workflow. There
is no server-side start, stop, completion, owner, or status lifecycle. Without
an explicit `run_id`, one is generated when the SDK client starts and shared by
every event from that client instance. A long-lived client can therefore emit
one run for months; constructing one client per request creates one run per
request. Neither automatically means one business job.

When evidence must follow one business job across workers, retries, process
restarts, or deployments, create an opaque run ID in the workload orchestrator,
persist it with that job, and pass it to every reporting client. Do not derive a
run ID from model conversation memory.

`record()` returns promptly after enqueueing. Call `flush()` before a short-lived
process exits, or use a context manager so shutdown drains the queue:

```python
with CogPlane(key=os.environ["COGPLANE_INGEST_KEY"]) as cog:
    cog.record(agent="invoice-bot", input="Invoice 42", output="Approved")
```

The queue is bounded and drops its oldest pending item rather than blocking the
agent. Inspect `cog.metrics` for `queue_size`, `dropped_count`, and
`failed_count`. Set `strict=True` only when evidence delivery must raise back to
the caller; this can affect the customer workload.

### 4. Auto-instrument an existing model client

```python
cog.instrument_openai(openai_client, agent="invoice-bot")
result = openai_client.chat.completions.create(model="gpt-5", messages=messages)
cog.uninstrument_openai(openai_client)
```

```python
cog.instrument_anthropic(anthropic_client, agent="invoice-bot")
result = anthropic_client.messages.create(
    model="claude-sonnet-5", max_tokens=500, messages=messages
)
cog.uninstrument_anthropic(anthropic_client)
```

Instrumentation returns the vendor's original object and preserves the
vendor's original exception. CogPlane recording failures are logged but do not
replace a successful model response. Streaming responses are never consumed;
CogPlane records metadata only.

### 5. Prove which registered agent sent the event

Tenant HMAC authenticates the tenant credential used for an event. For individual agent proof,
register the agent in CogPlane and use its one-time `agt_` credential:

```python
agent = cog.agent("invoice-bot", key=os.environ["COGPLANE_AGENT_KEY"])
agent.record(input="Approve invoice 42?", output="Escalated")
```

The server can require this second agent HMAC with
`COGPLANE_REQUIRE_AGENT_PROOF=true`.

Production always requires `actor` to match an active agent registered in the
same tenant. Development and staging retain observe-only compatibility unless
`COGPLANE_REQUIRE_REGISTERED_AGENTS=true` is set. Registration establishes
tenant-authorized attribution; the second agent HMAC shows that the sender held
the registered agent's shared credential. Because HMAC is symmetric, this is
not third-party non-repudiation.

## Download an Evidence Pack

Evidence Pack download is a server API operation, separate from asynchronous
SDK ingestion. Provision an RBAC actor with `export.read`, then call
`GET /evidence/pack` with canonical tenant headers and the required `tenant`,
`from`, and `to` query fields. Optional repeated `agent`, `department`, and
`include` filters scope activity, drift, health, and usage consistently.

The zip contains HMAC-authenticated JSON evidence when keyed, `SUMMARY.pdf`, `VERIFY.md`, and a
standard-library-only `verify.py`. Run `python verify.py pack.zip` offline.
Provide `--key` through a separate approved channel to verify HMAC authenticity;
the signing key is never included in the pack. Filtered activity proves
per-record integrity and sealed-window membership, not an unbroken chain.
See the root API documentation for a complete request example.

## Compatibility path

Existing integrations can continue constructing `CogPlaneClient` with an
endpoint, canonical `org/project/env` tenant, and signing key. That constructor
remains strict by default to avoid silently changing legacy behavior. Legacy
three-field ingestion tokens also continue to decode byte-for-byte as before.
If `CogPlane` receives both an embedded actor key and an explicit `api_key=`,
the explicit key wins.
