elan-agentkit-contracts 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.
- elan_agentkit_contracts-0.1.0/.gitignore +45 -0
- elan_agentkit_contracts-0.1.0/LICENSE +202 -0
- elan_agentkit_contracts-0.1.0/PKG-INFO +80 -0
- elan_agentkit_contracts-0.1.0/README.md +58 -0
- elan_agentkit_contracts-0.1.0/pyproject.toml +72 -0
- elan_agentkit_contracts-0.1.0/src/elan_agentkit_contracts/__init__.py +148 -0
- elan_agentkit_contracts-0.1.0/src/elan_agentkit_contracts/artifacts.py +216 -0
- elan_agentkit_contracts-0.1.0/src/elan_agentkit_contracts/deploy_spec.py +1161 -0
- elan_agentkit_contracts-0.1.0/src/elan_agentkit_contracts/envelopes.py +285 -0
- elan_agentkit_contracts-0.1.0/src/elan_agentkit_contracts/identity.py +906 -0
- elan_agentkit_contracts-0.1.0/src/elan_agentkit_contracts/manifest.py +1207 -0
- elan_agentkit_contracts-0.1.0/src/elan_agentkit_contracts/oauth.py +55 -0
- elan_agentkit_contracts-0.1.0/src/elan_agentkit_contracts/pricing.py +611 -0
- elan_agentkit_contracts-0.1.0/src/elan_agentkit_contracts/py.typed +0 -0
- elan_agentkit_contracts-0.1.0/src/elan_agentkit_contracts/subjects.py +70 -0
- elan_agentkit_contracts-0.1.0/src/elan_agentkit_contracts/templates/__init__.py +43 -0
- elan_agentkit_contracts-0.1.0/src/elan_agentkit_contracts/templates/agent.py.tmpl +61 -0
- elan_agentkit_contracts-0.1.0/src/elan_agentkit_contracts/templates/workflow.py.tmpl +80 -0
- elan_agentkit_contracts-0.1.0/src/elan_agentkit_contracts/tickets.py +67 -0
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
__pycache__/
|
|
2
|
+
*.py[cod]
|
|
3
|
+
.venv/
|
|
4
|
+
.env
|
|
5
|
+
.env.docker
|
|
6
|
+
.uvcache/
|
|
7
|
+
dist/
|
|
8
|
+
build/
|
|
9
|
+
*.egg-info/
|
|
10
|
+
node_modules/
|
|
11
|
+
.next/
|
|
12
|
+
# TypeScript incremental build cache: rewritten by every portal build, so
|
|
13
|
+
# tracking it dirties the tree on each one and now on every CI run.
|
|
14
|
+
*.tsbuildinfo
|
|
15
|
+
.terraform/
|
|
16
|
+
.terraform.lock.hcl
|
|
17
|
+
tfplan
|
|
18
|
+
*.tfstate*
|
|
19
|
+
.pytest_cache/
|
|
20
|
+
.ruff_cache/
|
|
21
|
+
catalog.json
|
|
22
|
+
.ref/
|
|
23
|
+
|
|
24
|
+
.local/
|
|
25
|
+
# Per environment (ADR-0179): one shared file meant building for a second
|
|
26
|
+
# environment overwrote the first's recorded digests.
|
|
27
|
+
.platform-digests.*
|
|
28
|
+
|
|
29
|
+
# Terraform plan files. Build artefacts, and a plan can carry values read
|
|
30
|
+
# from state — including ones marked sensitive. `tfplan` alone did not match
|
|
31
|
+
# `np.tfplan`, which is how one came to be committed.
|
|
32
|
+
*.tfplan
|
|
33
|
+
|
|
34
|
+
# Per-developer Claude Code settings. `.claude/settings.json` is the shared,
|
|
35
|
+
# checked-in one; this is the personal override beside it, and it routinely
|
|
36
|
+
# holds machine-specific permission grants — a `kubectl exec` allowance for
|
|
37
|
+
# somebody's own cluster has no business in a repo that is also the starter
|
|
38
|
+
# template for new projects.
|
|
39
|
+
.claude/settings.local.json
|
|
40
|
+
|
|
41
|
+
# GENERATED AT BUILD from the prerendered documentation, by
|
|
42
|
+
# ui/console/scripts/gen-llms.mjs. A build artifact like `.next` and the SDK's
|
|
43
|
+
# `dist`: committing it would mean a second copy of every documentation page
|
|
44
|
+
# in the history, going stale between builds.
|
|
45
|
+
ui/console/public/llms-full.txt
|
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: elan-agentkit-contracts
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: The wire models, manifest schema and deploy spec the Elan SDK and CLI share with the platform
|
|
5
|
+
Project-URL: Homepage, https://openelan.ai
|
|
6
|
+
Project-URL: Documentation, https://openelan.ai/app/docs
|
|
7
|
+
Author-email: Elan <support@openelan.ai>
|
|
8
|
+
License-Expression: Apache-2.0
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Keywords: adk,agent-platform,agents,contracts,llm
|
|
11
|
+
Classifier: Development Status :: 4 - Beta
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Programming Language :: Python :: 3
|
|
14
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
16
|
+
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
|
17
|
+
Classifier: Typing :: Typed
|
|
18
|
+
Requires-Python: >=3.12
|
|
19
|
+
Requires-Dist: pydantic>=2.9
|
|
20
|
+
Requires-Dist: pyyaml>=6.0
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
|
|
23
|
+
# elan-agentkit-contracts
|
|
24
|
+
|
|
25
|
+
The models the Elan platform and its clients both read: the event envelopes, the
|
|
26
|
+
agent manifest, the `elan.yaml` deploy spec, the artifact scope vocabulary and
|
|
27
|
+
the naming rules every derived identifier follows.
|
|
28
|
+
|
|
29
|
+
You almost certainly do not need to install this directly. `elan-sdk` and
|
|
30
|
+
`elan-cli` depend on it, and installing either brings it along.
|
|
31
|
+
|
|
32
|
+
```bash
|
|
33
|
+
uv add elan-agentkit-contracts
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
Requires Python 3.12 or newer. Its only dependencies are `pydantic` and
|
|
37
|
+
`pyyaml`.
|
|
38
|
+
|
|
39
|
+
## Why it is a separate package
|
|
40
|
+
|
|
41
|
+
The SDK validates an artifact filename before asking for an upload ticket, and
|
|
42
|
+
the CLI's `elan validate` answers the same question the deploy service will.
|
|
43
|
+
Both are only worth anything while there is **one** copy of each rule — a client
|
|
44
|
+
that reimplements a predicate passes its own tests against its own copy, and
|
|
45
|
+
nothing compares the copies.
|
|
46
|
+
|
|
47
|
+
So these modules are shared rather than mirrored. What is *not* shared is
|
|
48
|
+
everything that verifies, mints or connects: the token verifiers, the ticket
|
|
49
|
+
minter, the database layer, the broker and the push transports stay in the
|
|
50
|
+
platform's own package. A client has no business holding a verifier, and your
|
|
51
|
+
application image has no business carrying a Pub/Sub SDK.
|
|
52
|
+
|
|
53
|
+
## What is in it
|
|
54
|
+
|
|
55
|
+
| Module | What it holds |
|
|
56
|
+
|---|---|
|
|
57
|
+
| `envelopes` | `AgentEventEnvelope`, `InvocationEnvelope`, `ResumeEnvelope`, `EventKind` |
|
|
58
|
+
| `manifest` | `AgentManifest`, `WorkflowManifest`, `ActionPolicy`, `Rule`, `Billing`, `Limits` |
|
|
59
|
+
| `deploy_spec` | `DeploySpec`, `spec_from_yaml`, `cross_check`, `Problem` |
|
|
60
|
+
| `identity` | slug rules and every name derived from `(tenant, project, agent)` |
|
|
61
|
+
| `artifacts` | the four artifact scopes, and what a filename may say |
|
|
62
|
+
| `pricing` | the price grammar and tier arithmetic |
|
|
63
|
+
| `tickets` | `TICKET_ISSUER`, `TICKET_QUERY_PARAM`, `stream_url` |
|
|
64
|
+
| `subjects` | `END_USER_PREFIX`, `TENANT_SCOPE`, `end_user_of` |
|
|
65
|
+
| `oauth` | `token_scope` — the one non-standard part of an OAuth request here |
|
|
66
|
+
| `templates` | what `elan new agent` scaffolds |
|
|
67
|
+
|
|
68
|
+
## Stability
|
|
69
|
+
|
|
70
|
+
Pre-1.0 and versioned with the rest of the platform's client packages. These are
|
|
71
|
+
wire contracts, so a field is added far more often than one changes meaning;
|
|
72
|
+
when one does, it goes in the changelog with the version that introduced it.
|
|
73
|
+
|
|
74
|
+
## Documentation
|
|
75
|
+
|
|
76
|
+
<https://openelan.ai/app/docs>
|
|
77
|
+
|
|
78
|
+
## Licence
|
|
79
|
+
|
|
80
|
+
Apache-2.0. See `LICENSE`.
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
# elan-agentkit-contracts
|
|
2
|
+
|
|
3
|
+
The models the Elan platform and its clients both read: the event envelopes, the
|
|
4
|
+
agent manifest, the `elan.yaml` deploy spec, the artifact scope vocabulary and
|
|
5
|
+
the naming rules every derived identifier follows.
|
|
6
|
+
|
|
7
|
+
You almost certainly do not need to install this directly. `elan-sdk` and
|
|
8
|
+
`elan-cli` depend on it, and installing either brings it along.
|
|
9
|
+
|
|
10
|
+
```bash
|
|
11
|
+
uv add elan-agentkit-contracts
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Requires Python 3.12 or newer. Its only dependencies are `pydantic` and
|
|
15
|
+
`pyyaml`.
|
|
16
|
+
|
|
17
|
+
## Why it is a separate package
|
|
18
|
+
|
|
19
|
+
The SDK validates an artifact filename before asking for an upload ticket, and
|
|
20
|
+
the CLI's `elan validate` answers the same question the deploy service will.
|
|
21
|
+
Both are only worth anything while there is **one** copy of each rule — a client
|
|
22
|
+
that reimplements a predicate passes its own tests against its own copy, and
|
|
23
|
+
nothing compares the copies.
|
|
24
|
+
|
|
25
|
+
So these modules are shared rather than mirrored. What is *not* shared is
|
|
26
|
+
everything that verifies, mints or connects: the token verifiers, the ticket
|
|
27
|
+
minter, the database layer, the broker and the push transports stay in the
|
|
28
|
+
platform's own package. A client has no business holding a verifier, and your
|
|
29
|
+
application image has no business carrying a Pub/Sub SDK.
|
|
30
|
+
|
|
31
|
+
## What is in it
|
|
32
|
+
|
|
33
|
+
| Module | What it holds |
|
|
34
|
+
|---|---|
|
|
35
|
+
| `envelopes` | `AgentEventEnvelope`, `InvocationEnvelope`, `ResumeEnvelope`, `EventKind` |
|
|
36
|
+
| `manifest` | `AgentManifest`, `WorkflowManifest`, `ActionPolicy`, `Rule`, `Billing`, `Limits` |
|
|
37
|
+
| `deploy_spec` | `DeploySpec`, `spec_from_yaml`, `cross_check`, `Problem` |
|
|
38
|
+
| `identity` | slug rules and every name derived from `(tenant, project, agent)` |
|
|
39
|
+
| `artifacts` | the four artifact scopes, and what a filename may say |
|
|
40
|
+
| `pricing` | the price grammar and tier arithmetic |
|
|
41
|
+
| `tickets` | `TICKET_ISSUER`, `TICKET_QUERY_PARAM`, `stream_url` |
|
|
42
|
+
| `subjects` | `END_USER_PREFIX`, `TENANT_SCOPE`, `end_user_of` |
|
|
43
|
+
| `oauth` | `token_scope` — the one non-standard part of an OAuth request here |
|
|
44
|
+
| `templates` | what `elan new agent` scaffolds |
|
|
45
|
+
|
|
46
|
+
## Stability
|
|
47
|
+
|
|
48
|
+
Pre-1.0 and versioned with the rest of the platform's client packages. These are
|
|
49
|
+
wire contracts, so a field is added far more often than one changes meaning;
|
|
50
|
+
when one does, it goes in the changelog with the version that introduced it.
|
|
51
|
+
|
|
52
|
+
## Documentation
|
|
53
|
+
|
|
54
|
+
<https://openelan.ai/app/docs>
|
|
55
|
+
|
|
56
|
+
## Licence
|
|
57
|
+
|
|
58
|
+
Apache-2.0. See `LICENSE`.
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "elan-agentkit-contracts"
|
|
3
|
+
version = "0.1.0"
|
|
4
|
+
description = "The wire models, manifest schema and deploy spec the Elan SDK and CLI share with the platform"
|
|
5
|
+
readme = "README.md"
|
|
6
|
+
requires-python = ">=3.12"
|
|
7
|
+
|
|
8
|
+
# SPDX, NOT A CLASSIFIER (PEP 639). The two spellings are mutually exclusive —
|
|
9
|
+
# a distribution carrying both a `License-Expression` and a
|
|
10
|
+
# `License :: OSI Approved :: …` classifier is refused by a current build
|
|
11
|
+
# backend, so the classifier list below deliberately has no `License ::` line.
|
|
12
|
+
license = "Apache-2.0"
|
|
13
|
+
# A REAL FILE, NOT A SYMLINK TO THE ROOT. A symlinked `LICENSE` builds a wheel
|
|
14
|
+
# fine and then fails the SDIST — `uv build` refuses with "symlink destination
|
|
15
|
+
# for ../../LICENSE is outside of the target directory". Byte-identity with the
|
|
16
|
+
# root copy is asserted by
|
|
17
|
+
# `tests/test_packaging.py::test_every_published_package_ships_the_licence`.
|
|
18
|
+
license-files = ["LICENSE"]
|
|
19
|
+
|
|
20
|
+
authors = [{ name = "Elan", email = "support@openelan.ai" }]
|
|
21
|
+
keywords = ["agents", "llm", "adk", "contracts", "agent-platform"]
|
|
22
|
+
classifiers = [
|
|
23
|
+
"Development Status :: 4 - Beta",
|
|
24
|
+
"Intended Audience :: Developers",
|
|
25
|
+
"Programming Language :: Python :: 3",
|
|
26
|
+
"Programming Language :: Python :: 3.12",
|
|
27
|
+
"Programming Language :: Python :: 3.13",
|
|
28
|
+
"Topic :: Software Development :: Libraries :: Python Modules",
|
|
29
|
+
"Typing :: Typed",
|
|
30
|
+
]
|
|
31
|
+
|
|
32
|
+
# TWO DEPENDENCIES, AND THAT IS THE POINT OF THE PACKAGE (ADR-0197).
|
|
33
|
+
#
|
|
34
|
+
# `elan-sdk` and `elan-cli` needed the manifest schema, the wire envelopes, the
|
|
35
|
+
# artifact scope vocabulary and the deploy spec. Getting them from
|
|
36
|
+
# `agentkit-core` would have put the token verifiers, the ticket minter, the
|
|
37
|
+
# database layer, the broker, the push transports and optional extras on
|
|
38
|
+
# google-cloud-pubsub, pyjwt[crypto], sqlalchemy and google-adk into a
|
|
39
|
+
# developer's application image. None of that is a contract.
|
|
40
|
+
#
|
|
41
|
+
# NO OPTIONAL EXTRAS AT ALL, deliberately. An extra is a backend a deployment
|
|
42
|
+
# may select; there is nothing here to select. If a module in this package ever
|
|
43
|
+
# wants one, that is the signal it belongs on the other side of the split.
|
|
44
|
+
dependencies = [
|
|
45
|
+
"pydantic>=2.9",
|
|
46
|
+
# `spec_from_yaml` IS THE ONLY PARSER FOR elan.yaml AND IT LIVES HERE, so
|
|
47
|
+
# this is not optional the way an extra would be — it is the deploy
|
|
48
|
+
# contract itself.
|
|
49
|
+
#
|
|
50
|
+
# DECLARED BECAUSE IT WAS ALREADY BEING GOT BY LUCK, and that history
|
|
51
|
+
# travelled with the module out of `agentkit-core`. Nothing listed it: the
|
|
52
|
+
# deploy service had it because `uvicorn[standard]` pulls it in, and
|
|
53
|
+
# agentkit-runtime happened to name it. Both worked. `elan-cli` installs
|
|
54
|
+
# neither, so `uv tool install` produced a CLI that could not read the one
|
|
55
|
+
# file every command of it is about — `elan validate` answered "No module
|
|
56
|
+
# named 'yaml'", which names a package the developer never asked for and
|
|
57
|
+
# points at nothing they can fix.
|
|
58
|
+
"pyyaml>=6.0",
|
|
59
|
+
]
|
|
60
|
+
|
|
61
|
+
# NO `Repository` OR `Issues` URL while the source repository is private: both
|
|
62
|
+
# would be a 404 on a public project page, which is worse than an absent link.
|
|
63
|
+
[project.urls]
|
|
64
|
+
Homepage = "https://openelan.ai"
|
|
65
|
+
Documentation = "https://openelan.ai/app/docs"
|
|
66
|
+
|
|
67
|
+
[build-system]
|
|
68
|
+
requires = ["hatchling"]
|
|
69
|
+
build-backend = "hatchling.build"
|
|
70
|
+
|
|
71
|
+
[tool.hatch.build.targets.wheel]
|
|
72
|
+
packages = ["src/elan_agentkit_contracts"]
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
"""The contracts a client and this platform have to agree on.
|
|
2
|
+
|
|
3
|
+
WHAT THIS PACKAGE IS FOR. `elan-sdk` and `elan-cli` are published to PyPI, and
|
|
4
|
+
both needed the wire models, the manifest schema, the artifact scope vocabulary
|
|
5
|
+
and the deploy spec. Before ADR-0197 they got them from `agentkit-core`, which
|
|
6
|
+
is a workspace path dependency — uv-local metadata that is NOT written into a
|
|
7
|
+
wheel, so a published wheel declared a bare `Requires-Dist: agentkit-core` that
|
|
8
|
+
pip would resolve from an index that has never seen it.
|
|
9
|
+
|
|
10
|
+
PUBLISHING `agentkit-core` INSTEAD WAS THE OBVIOUS FIX AND THE WRONG ONE. It
|
|
11
|
+
carries the token verifiers, the ticket minter, the database layer, the broker,
|
|
12
|
+
the push transports and the email and comms clients, with optional extras on
|
|
13
|
+
google-cloud-pubsub, pyjwt[crypto], sqlalchemy and google-adk. None of that
|
|
14
|
+
belongs in a developer's application image, and a client package containing a
|
|
15
|
+
verifier implies the client verifies something.
|
|
16
|
+
|
|
17
|
+
SO THIS IS THE SUBSET A CLIENT GENUINELY NEEDS, with pydantic and pyyaml as its
|
|
18
|
+
only dependencies. It is a LEAF: it imports neither `agentkit_core` nor
|
|
19
|
+
`agentkit_deploy`, and it never will — that is what keeps it installable beside
|
|
20
|
+
somebody else's code.
|
|
21
|
+
|
|
22
|
+
MOVED, NEVER COPIED. ADR-0116 is about exactly this: `elan_cli/stream.py` once
|
|
23
|
+
kept its own copy of the terminal-event predicate and hung for ever on every
|
|
24
|
+
paused run, and `ui/portal/lib/types.ts` hand-mirrored `AgentEventEnvelope` and
|
|
25
|
+
silently lost three fields. Two copies that agree today pass every behavioural
|
|
26
|
+
test and diverge the day one is edited. So `agentkit_core.identity`,
|
|
27
|
+
`.manifest`, `.envelopes`, `.artifacts`, `.pricing`, `.deploy_spec` and
|
|
28
|
+
`.templates` are now SHIMS that re-export from here, and `agentkit_core.auth`
|
|
29
|
+
and `.tickets` import their vocabulary back from `subjects`, `oauth` and
|
|
30
|
+
`tickets`.
|
|
31
|
+
|
|
32
|
+
THE NAME SAYS `elan` ON BOTH SIDES, DELIBERATELY. Everything under `agentkit_*`
|
|
33
|
+
in this repo is brand-free so a derived project renames nothing; a published
|
|
34
|
+
distribution is the opposite kind of name — a developer types it. A neutral
|
|
35
|
+
import name inside a branded distribution would be a distinction every reader
|
|
36
|
+
had to be told about, so `tests/test_template.py`'s brand scan widens by one
|
|
37
|
+
narrow allowance instead.
|
|
38
|
+
"""
|
|
39
|
+
|
|
40
|
+
from elan_agentkit_contracts.artifacts import (
|
|
41
|
+
ARTIFACT_SCOPE_PREFIXES,
|
|
42
|
+
MAX_ARTIFACT_BYTES,
|
|
43
|
+
SHARED_SCOPES,
|
|
44
|
+
ArtifactNameRefused,
|
|
45
|
+
ArtifactScope,
|
|
46
|
+
qualify,
|
|
47
|
+
scope_of,
|
|
48
|
+
validate_artifact_filename,
|
|
49
|
+
)
|
|
50
|
+
from elan_agentkit_contracts.deploy_spec import (
|
|
51
|
+
DeploySpec,
|
|
52
|
+
Problem,
|
|
53
|
+
cross_check,
|
|
54
|
+
spec_from_yaml,
|
|
55
|
+
)
|
|
56
|
+
from elan_agentkit_contracts.envelopes import (
|
|
57
|
+
AgentEventEnvelope,
|
|
58
|
+
EventKind,
|
|
59
|
+
InvocationEnvelope,
|
|
60
|
+
MessagePart,
|
|
61
|
+
ResumeEnvelope,
|
|
62
|
+
new_id,
|
|
63
|
+
)
|
|
64
|
+
from elan_agentkit_contracts.identity import (
|
|
65
|
+
AgentRef,
|
|
66
|
+
AgentSlug,
|
|
67
|
+
ProjectSlug,
|
|
68
|
+
TenantSlug,
|
|
69
|
+
)
|
|
70
|
+
from elan_agentkit_contracts.manifest import (
|
|
71
|
+
SLUG_PATTERN,
|
|
72
|
+
ActionPolicy,
|
|
73
|
+
AgentManifest,
|
|
74
|
+
BaseTargetManifest,
|
|
75
|
+
Billing,
|
|
76
|
+
Limits,
|
|
77
|
+
NodeOverrides,
|
|
78
|
+
Rule,
|
|
79
|
+
TargetManifest,
|
|
80
|
+
Tier,
|
|
81
|
+
ToolBinding,
|
|
82
|
+
ToolPhrasing,
|
|
83
|
+
WorkflowManifest,
|
|
84
|
+
)
|
|
85
|
+
from elan_agentkit_contracts.oauth import token_scope
|
|
86
|
+
from elan_agentkit_contracts.subjects import (
|
|
87
|
+
END_USER_PREFIX,
|
|
88
|
+
TENANT_SCOPE,
|
|
89
|
+
end_user_of,
|
|
90
|
+
)
|
|
91
|
+
from elan_agentkit_contracts.tickets import (
|
|
92
|
+
TICKET_ISSUER,
|
|
93
|
+
TICKET_QUERY_PARAM,
|
|
94
|
+
stream_url,
|
|
95
|
+
)
|
|
96
|
+
|
|
97
|
+
#: THE HEADLINE NAMES ONLY, not every one of the 163 a submodule exports.
|
|
98
|
+
#:
|
|
99
|
+
#: A FRONT DOOR IS NOT AN INDEX. `agentkit_core.__init__` makes the same choice
|
|
100
|
+
#: and for the same reason: a flat re-export of everything turns every rename
|
|
101
|
+
#: inside a submodule into a change here, and it hides WHICH contract a name
|
|
102
|
+
#: belongs to at the call site. `from elan_agentkit_contracts.identity import
|
|
103
|
+
#: artifact_bucket_of` says what it is about; `from elan_agentkit_contracts
|
|
104
|
+
#: import artifact_bucket_of` does not.
|
|
105
|
+
__all__ = [
|
|
106
|
+
"ARTIFACT_SCOPE_PREFIXES",
|
|
107
|
+
"END_USER_PREFIX",
|
|
108
|
+
"MAX_ARTIFACT_BYTES",
|
|
109
|
+
"SHARED_SCOPES",
|
|
110
|
+
"SLUG_PATTERN",
|
|
111
|
+
"TENANT_SCOPE",
|
|
112
|
+
"TICKET_ISSUER",
|
|
113
|
+
"TICKET_QUERY_PARAM",
|
|
114
|
+
"ActionPolicy",
|
|
115
|
+
"AgentEventEnvelope",
|
|
116
|
+
"AgentManifest",
|
|
117
|
+
"AgentRef",
|
|
118
|
+
"AgentSlug",
|
|
119
|
+
"ArtifactNameRefused",
|
|
120
|
+
"ArtifactScope",
|
|
121
|
+
"BaseTargetManifest",
|
|
122
|
+
"Billing",
|
|
123
|
+
"DeploySpec",
|
|
124
|
+
"EventKind",
|
|
125
|
+
"InvocationEnvelope",
|
|
126
|
+
"Limits",
|
|
127
|
+
"MessagePart",
|
|
128
|
+
"NodeOverrides",
|
|
129
|
+
"Problem",
|
|
130
|
+
"ProjectSlug",
|
|
131
|
+
"ResumeEnvelope",
|
|
132
|
+
"Rule",
|
|
133
|
+
"TargetManifest",
|
|
134
|
+
"TenantSlug",
|
|
135
|
+
"Tier",
|
|
136
|
+
"ToolBinding",
|
|
137
|
+
"ToolPhrasing",
|
|
138
|
+
"WorkflowManifest",
|
|
139
|
+
"cross_check",
|
|
140
|
+
"end_user_of",
|
|
141
|
+
"new_id",
|
|
142
|
+
"qualify",
|
|
143
|
+
"scope_of",
|
|
144
|
+
"spec_from_yaml",
|
|
145
|
+
"stream_url",
|
|
146
|
+
"token_scope",
|
|
147
|
+
"validate_artifact_filename",
|
|
148
|
+
]
|