conseqa 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
conseqa-0.1.0/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2026 Conseqa contributors
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1 @@
1
+ prune tests
conseqa-0.1.0/PKG-INFO ADDED
@@ -0,0 +1,209 @@
1
+ Metadata-Version: 2.4
2
+ Name: conseqa
3
+ Version: 0.1.0
4
+ Summary: Verify what your agent actually changed: the Conseqa SDK for Python
5
+ Author: Devraj Jhala
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://www.conseqa.dev
8
+ Project-URL: Documentation, https://www.conseqa.dev/docs
9
+ Keywords: ai agents,verification,observability,idempotency,outcomes
10
+ Classifier: Development Status :: 4 - Beta
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: Operating System :: OS Independent
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.9
15
+ Classifier: Programming Language :: Python :: 3.10
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Programming Language :: Python :: 3.13
19
+ Classifier: Topic :: Software Development :: Libraries
20
+ Classifier: Typing :: Typed
21
+ Requires-Python: >=3.9
22
+ Description-Content-Type: text/markdown
23
+ License-File: LICENSE
24
+ Provides-Extra: tracing
25
+ Requires-Dist: opentelemetry-api>=1.20; extra == "tracing"
26
+ Dynamic: license-file
27
+
28
+ # Conseqa for Python
29
+
30
+ Your agent calls a provider and gets a reply, or does not. Conseqa records what the call was
31
+ meant to do before it is made, then reads the system of record afterwards to establish what
32
+ is actually true: verified, failed, or honestly unknown.
33
+
34
+ This package is the application side for Python programs. It has no dependencies.
35
+
36
+ ```bash
37
+ pip install conseqa
38
+ ```
39
+
40
+ It needs Python 3.9 or newer, and a Conseqa runner, version 0.1.8 or newer, to talk to. The
41
+ runner and the tool that builds contracts are Node.js programs; the guide at
42
+ <https://www.conseqa.dev/docs> sets them up, and `npx @conseqa/cli quickstart` gives you both
43
+ running in two minutes.
44
+
45
+ ## Protect a call
46
+
47
+ This protects the refund that the quickstart sets up. `create_refund` stands for the call your
48
+ program already makes.
49
+
50
+ ```python
51
+ import os
52
+
53
+ from conseqa import Conseqa, ambiguous, load_contract_package, rejected
54
+
55
+
56
+ def what_an_error_proves(error):
57
+ # A refusal with a 4xx status proves the refund was not made.
58
+ # Anything else, a dropped connection above all, proves nothing either way.
59
+ status = getattr(error, "status", None)
60
+ if isinstance(status, int) and 400 <= status < 500:
61
+ return rejected(f"http_{status}")
62
+ return ambiguous("no_reply")
63
+
64
+
65
+ package = load_contract_package("dist/conseqa")
66
+ refund_processed = package.contract(
67
+ "quickstart.refund.processed",
68
+ 1,
69
+ # What identifies the thing that was made, taken from the service's reply.
70
+ bind_result=lambda reply: {"refundId": reply["id"]} if reply.get("id") else None,
71
+ classify_exception=what_an_error_proves,
72
+ )
73
+ conseqa = Conseqa(
74
+ package,
75
+ runner_url="http://127.0.0.1:4319",
76
+ sidecar_token=os.environ.get("CONSEQA_SIDECAR_TOKEN"),
77
+ )
78
+
79
+ intent = {"paymentId": "pay_1001", "amountMinor": 2500, "currency": "USD"}
80
+ reply = conseqa.protect(
81
+ refund_processed,
82
+ action_key="ticket-8042-refund",
83
+ intent=intent,
84
+ # The call you already make, given the reference to send with it.
85
+ execute=lambda call: create_refund({**intent, "reference": call.provider_correlation_key}),
86
+ )
87
+ ```
88
+
89
+ `protect` returns what your call returned and raises what it raised. In between it tells
90
+ the runner what was intended, that the call is starting, and how it ended. The runner then
91
+ reads your system with its own read-only credential and decides the verdict, which appears
92
+ in the dashboard.
93
+
94
+ - `action_key` is one stable key for the business operation, such as the ticket or order it
95
+ belongs to. A key that was already used raises `DuplicateActionError` and the call is not
96
+ made.
97
+ - With the default `mode="required"`, the call is not made unless the intent was recorded
98
+ first; a runner that cannot be reached raises `ProtectionUnavailableError`. With
99
+ `mode="best_effort"` the call goes ahead anyway and shows as an unprotected gap.
100
+ - `intent` is what the call is meant to do, in the shape of the contract's intent schema.
101
+
102
+ ## The contract
103
+
104
+ A contract package is built once with `conseqa contracts build` and installed in the runner.
105
+ Its runner half, which finds and reads the record, runs inside the runner and stays as it
106
+ is. Its application half is three small decisions, and a Python program makes them in
107
+ Python, as arguments to `package.contract`:
108
+
109
+ | Argument | What it decides | Left out |
110
+ | -------------------- | ------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------- |
111
+ | `bind_result` | What identifies the record, from the call's reply. Return `None` when the reply does not say. | Required |
112
+ | `classify_exception` | What an exception proves: `rejected(...)`, `not_executed(...)` or `ambiguous(...)`. | Every exception is ambiguous, the safe reading. |
113
+ | `correlation_key` | The reference sent with the call, so that a record whose reply was lost can be found by an exact match afterwards. | `cq_` and 24 random hex digits |
114
+
115
+ `load_contract_package` hashes the package's files again and compares the result with its
116
+ manifest, so a program never registers an intent against a build other than the one on disk.
117
+
118
+ ## Connectors
119
+
120
+ For a provider Conseqa has a connector for, the application half is already written.
121
+ `conseqa.connectors` gives it in Python, and helps build the request so that the key goes
122
+ where the runner will look for it. Build the contract package from the JavaScript
123
+ connector as usual; its runner half reads the provider.
124
+
125
+ | Provider | Contract (from the package) | Request helper | Where the key goes |
126
+ | ----------------- | --------------------------- | --------------------------- | --------------------------------------------------- |
127
+ | Stripe refunds | `stripe_refund(package)` | `decorate_stripe_refund` | refund metadata and the idempotency key |
128
+ | Razorpay refunds | `razorpay_refund(package)` | `decorate_razorpay_refund` | the refund's receipt and `X-Refund-Idempotency` |
129
+ | Shopify refunds | `shopify_refund(package)` | `decorate_shopify_refund` | the refund's note and `@idempotent` |
130
+ | Cashfree refunds | `cashfree_refund(package)` | `decorate_cashfree_refund` | the refund's own `refund_id` |
131
+ | RazorpayX payouts | `razorpayx_payout(package)` | `decorate_razorpayx_payout` | the payout's `reference_id` and its idempotency key |
132
+
133
+ ```python
134
+ import requests
135
+ from conseqa.connectors import cashfree_refund, decorate_cashfree_refund
136
+
137
+ refund = cashfree_refund(package)
138
+ intent = {"orderId": "order_8042", "amountMinor": 249950, "currency": "INR"}
139
+
140
+
141
+ def create_refund(call):
142
+ request = decorate_cashfree_refund(
143
+ intent, call.provider_correlation_key, {"refund_note": "Damaged on arrival"}
144
+ )
145
+ response = requests.post(
146
+ "https://api.cashfree.com/pg" + request["path"],
147
+ json=request["body"],
148
+ headers={**request["headers"], **cashfree_credentials},
149
+ timeout=10,
150
+ )
151
+ response.raise_for_status()
152
+ return response.json()
153
+
154
+
155
+ reply = conseqa.protect(
156
+ refund, action_key="ticket-8042-refund", intent=intent, execute=create_refund
157
+ )
158
+ ```
159
+
160
+ Each connector's exception rules read the shapes Python clients raise: `http_status` on
161
+ stripe-python's errors, `response.status_code` on those of requests and httpx. Raise
162
+ `conseqa.connectors.NotDispatchedError` only when your code can prove a request never
163
+ left the program; anything else is treated as possibly done, and the runner looks.
164
+
165
+ ## asyncio
166
+
167
+ ```python
168
+ reply = await conseqa.protect_async(
169
+ refund_processed,
170
+ action_key="ticket-8042-refund",
171
+ intent=intent,
172
+ execute=create_refund_async,
173
+ )
174
+ ```
175
+
176
+ `execute` may be a coroutine function. The requests to the runner are made off the event
177
+ loop. A call that is cancelled part way is reported as ambiguous, because it is.
178
+
179
+ ## Traces and coverage
180
+
181
+ If your program uses OpenTelemetry, each protected call gets a span in the trace that is
182
+ active, marked so that the dashboard can show the action inside the agent run that made it
183
+ and count coverage. Nothing needs configuring: installing `opentelemetry-api` is enough, and
184
+ `pip install "conseqa[tracing]"` does that. To count a run that was not protected, wrap it:
185
+
186
+ ```python
187
+ conseqa.observe("refund.create", lambda: create_refund(refund))
188
+ ```
189
+
190
+ ## What it raises
191
+
192
+ | Error | What happened |
193
+ | ------------------------------- | ----------------------------------------------------------------------------------- |
194
+ | `ProtectionUnavailableError` | A required action could not be recorded first, so the call was not made. |
195
+ | `DuplicateActionError` | The action key was already used, so the call was not made. Carries the earlier ids. |
196
+ | `RunnerUnavailableError` | The runner did not answer. The cause of a `ProtectionUnavailableError`. |
197
+ | `RunnerRejectedError` | The runner refused the request. Carries the status and what it replied. |
198
+ | `ContractPackageIntegrityError` | The built contract package does not match its manifest. Build it again. |
199
+ | `UnregisteredContractError` | The contract did not come from the package this client was given. |
200
+
201
+ Everything your own call raises is raised to you unchanged.
202
+
203
+ ## What this version does not do
204
+
205
+ There is no spool: when the runner cannot be reached, a required action stops and a
206
+ best-effort one runs unprotected. The JavaScript SDK can hold intents in an encrypted folder
207
+ shared with the runner; this one cannot yet.
208
+
209
+ Apache-2.0 licensed. Questions: <https://www.conseqa.dev/docs>.
@@ -0,0 +1,182 @@
1
+ # Conseqa for Python
2
+
3
+ Your agent calls a provider and gets a reply, or does not. Conseqa records what the call was
4
+ meant to do before it is made, then reads the system of record afterwards to establish what
5
+ is actually true: verified, failed, or honestly unknown.
6
+
7
+ This package is the application side for Python programs. It has no dependencies.
8
+
9
+ ```bash
10
+ pip install conseqa
11
+ ```
12
+
13
+ It needs Python 3.9 or newer, and a Conseqa runner, version 0.1.8 or newer, to talk to. The
14
+ runner and the tool that builds contracts are Node.js programs; the guide at
15
+ <https://www.conseqa.dev/docs> sets them up, and `npx @conseqa/cli quickstart` gives you both
16
+ running in two minutes.
17
+
18
+ ## Protect a call
19
+
20
+ This protects the refund that the quickstart sets up. `create_refund` stands for the call your
21
+ program already makes.
22
+
23
+ ```python
24
+ import os
25
+
26
+ from conseqa import Conseqa, ambiguous, load_contract_package, rejected
27
+
28
+
29
+ def what_an_error_proves(error):
30
+ # A refusal with a 4xx status proves the refund was not made.
31
+ # Anything else, a dropped connection above all, proves nothing either way.
32
+ status = getattr(error, "status", None)
33
+ if isinstance(status, int) and 400 <= status < 500:
34
+ return rejected(f"http_{status}")
35
+ return ambiguous("no_reply")
36
+
37
+
38
+ package = load_contract_package("dist/conseqa")
39
+ refund_processed = package.contract(
40
+ "quickstart.refund.processed",
41
+ 1,
42
+ # What identifies the thing that was made, taken from the service's reply.
43
+ bind_result=lambda reply: {"refundId": reply["id"]} if reply.get("id") else None,
44
+ classify_exception=what_an_error_proves,
45
+ )
46
+ conseqa = Conseqa(
47
+ package,
48
+ runner_url="http://127.0.0.1:4319",
49
+ sidecar_token=os.environ.get("CONSEQA_SIDECAR_TOKEN"),
50
+ )
51
+
52
+ intent = {"paymentId": "pay_1001", "amountMinor": 2500, "currency": "USD"}
53
+ reply = conseqa.protect(
54
+ refund_processed,
55
+ action_key="ticket-8042-refund",
56
+ intent=intent,
57
+ # The call you already make, given the reference to send with it.
58
+ execute=lambda call: create_refund({**intent, "reference": call.provider_correlation_key}),
59
+ )
60
+ ```
61
+
62
+ `protect` returns what your call returned and raises what it raised. In between it tells
63
+ the runner what was intended, that the call is starting, and how it ended. The runner then
64
+ reads your system with its own read-only credential and decides the verdict, which appears
65
+ in the dashboard.
66
+
67
+ - `action_key` is one stable key for the business operation, such as the ticket or order it
68
+ belongs to. A key that was already used raises `DuplicateActionError` and the call is not
69
+ made.
70
+ - With the default `mode="required"`, the call is not made unless the intent was recorded
71
+ first; a runner that cannot be reached raises `ProtectionUnavailableError`. With
72
+ `mode="best_effort"` the call goes ahead anyway and shows as an unprotected gap.
73
+ - `intent` is what the call is meant to do, in the shape of the contract's intent schema.
74
+
75
+ ## The contract
76
+
77
+ A contract package is built once with `conseqa contracts build` and installed in the runner.
78
+ Its runner half, which finds and reads the record, runs inside the runner and stays as it
79
+ is. Its application half is three small decisions, and a Python program makes them in
80
+ Python, as arguments to `package.contract`:
81
+
82
+ | Argument | What it decides | Left out |
83
+ | -------------------- | ------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------- |
84
+ | `bind_result` | What identifies the record, from the call's reply. Return `None` when the reply does not say. | Required |
85
+ | `classify_exception` | What an exception proves: `rejected(...)`, `not_executed(...)` or `ambiguous(...)`. | Every exception is ambiguous, the safe reading. |
86
+ | `correlation_key` | The reference sent with the call, so that a record whose reply was lost can be found by an exact match afterwards. | `cq_` and 24 random hex digits |
87
+
88
+ `load_contract_package` hashes the package's files again and compares the result with its
89
+ manifest, so a program never registers an intent against a build other than the one on disk.
90
+
91
+ ## Connectors
92
+
93
+ For a provider Conseqa has a connector for, the application half is already written.
94
+ `conseqa.connectors` gives it in Python, and helps build the request so that the key goes
95
+ where the runner will look for it. Build the contract package from the JavaScript
96
+ connector as usual; its runner half reads the provider.
97
+
98
+ | Provider | Contract (from the package) | Request helper | Where the key goes |
99
+ | ----------------- | --------------------------- | --------------------------- | --------------------------------------------------- |
100
+ | Stripe refunds | `stripe_refund(package)` | `decorate_stripe_refund` | refund metadata and the idempotency key |
101
+ | Razorpay refunds | `razorpay_refund(package)` | `decorate_razorpay_refund` | the refund's receipt and `X-Refund-Idempotency` |
102
+ | Shopify refunds | `shopify_refund(package)` | `decorate_shopify_refund` | the refund's note and `@idempotent` |
103
+ | Cashfree refunds | `cashfree_refund(package)` | `decorate_cashfree_refund` | the refund's own `refund_id` |
104
+ | RazorpayX payouts | `razorpayx_payout(package)` | `decorate_razorpayx_payout` | the payout's `reference_id` and its idempotency key |
105
+
106
+ ```python
107
+ import requests
108
+ from conseqa.connectors import cashfree_refund, decorate_cashfree_refund
109
+
110
+ refund = cashfree_refund(package)
111
+ intent = {"orderId": "order_8042", "amountMinor": 249950, "currency": "INR"}
112
+
113
+
114
+ def create_refund(call):
115
+ request = decorate_cashfree_refund(
116
+ intent, call.provider_correlation_key, {"refund_note": "Damaged on arrival"}
117
+ )
118
+ response = requests.post(
119
+ "https://api.cashfree.com/pg" + request["path"],
120
+ json=request["body"],
121
+ headers={**request["headers"], **cashfree_credentials},
122
+ timeout=10,
123
+ )
124
+ response.raise_for_status()
125
+ return response.json()
126
+
127
+
128
+ reply = conseqa.protect(
129
+ refund, action_key="ticket-8042-refund", intent=intent, execute=create_refund
130
+ )
131
+ ```
132
+
133
+ Each connector's exception rules read the shapes Python clients raise: `http_status` on
134
+ stripe-python's errors, `response.status_code` on those of requests and httpx. Raise
135
+ `conseqa.connectors.NotDispatchedError` only when your code can prove a request never
136
+ left the program; anything else is treated as possibly done, and the runner looks.
137
+
138
+ ## asyncio
139
+
140
+ ```python
141
+ reply = await conseqa.protect_async(
142
+ refund_processed,
143
+ action_key="ticket-8042-refund",
144
+ intent=intent,
145
+ execute=create_refund_async,
146
+ )
147
+ ```
148
+
149
+ `execute` may be a coroutine function. The requests to the runner are made off the event
150
+ loop. A call that is cancelled part way is reported as ambiguous, because it is.
151
+
152
+ ## Traces and coverage
153
+
154
+ If your program uses OpenTelemetry, each protected call gets a span in the trace that is
155
+ active, marked so that the dashboard can show the action inside the agent run that made it
156
+ and count coverage. Nothing needs configuring: installing `opentelemetry-api` is enough, and
157
+ `pip install "conseqa[tracing]"` does that. To count a run that was not protected, wrap it:
158
+
159
+ ```python
160
+ conseqa.observe("refund.create", lambda: create_refund(refund))
161
+ ```
162
+
163
+ ## What it raises
164
+
165
+ | Error | What happened |
166
+ | ------------------------------- | ----------------------------------------------------------------------------------- |
167
+ | `ProtectionUnavailableError` | A required action could not be recorded first, so the call was not made. |
168
+ | `DuplicateActionError` | The action key was already used, so the call was not made. Carries the earlier ids. |
169
+ | `RunnerUnavailableError` | The runner did not answer. The cause of a `ProtectionUnavailableError`. |
170
+ | `RunnerRejectedError` | The runner refused the request. Carries the status and what it replied. |
171
+ | `ContractPackageIntegrityError` | The built contract package does not match its manifest. Build it again. |
172
+ | `UnregisteredContractError` | The contract did not come from the package this client was given. |
173
+
174
+ Everything your own call raises is raised to you unchanged.
175
+
176
+ ## What this version does not do
177
+
178
+ There is no spool: when the runner cannot be reached, a required action stops and a
179
+ best-effort one runs unprotected. The JavaScript SDK can hold intents in an encrypted folder
180
+ shared with the runner; this one cannot yet.
181
+
182
+ Apache-2.0 licensed. Questions: <https://www.conseqa.dev/docs>.
@@ -0,0 +1,41 @@
1
+ [build-system]
2
+ requires = ["setuptools>=77"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "conseqa"
7
+ version = "0.1.0"
8
+ description = "Verify what your agent actually changed: the Conseqa SDK for Python"
9
+ readme = "README.md"
10
+ requires-python = ">=3.9"
11
+ license = "Apache-2.0"
12
+ license-files = ["LICENSE"]
13
+ authors = [{ name = "Devraj Jhala" }]
14
+ keywords = ["ai agents", "verification", "observability", "idempotency", "outcomes"]
15
+ classifiers = [
16
+ "Development Status :: 4 - Beta",
17
+ "Intended Audience :: Developers",
18
+ "Operating System :: OS Independent",
19
+ "Programming Language :: Python :: 3",
20
+ "Programming Language :: Python :: 3.9",
21
+ "Programming Language :: Python :: 3.10",
22
+ "Programming Language :: Python :: 3.11",
23
+ "Programming Language :: Python :: 3.12",
24
+ "Programming Language :: Python :: 3.13",
25
+ "Topic :: Software Development :: Libraries",
26
+ "Typing :: Typed",
27
+ ]
28
+ dependencies = []
29
+
30
+ [project.optional-dependencies]
31
+ tracing = ["opentelemetry-api>=1.20"]
32
+
33
+ [project.urls]
34
+ Homepage = "https://www.conseqa.dev"
35
+ Documentation = "https://www.conseqa.dev/docs"
36
+
37
+ [tool.setuptools.packages.find]
38
+ where = ["src"]
39
+
40
+ [tool.setuptools.package-data]
41
+ conseqa = ["py.typed"]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+