evo-agents-core-plugins 1.0.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.
@@ -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 [yyyy] [name of copyright owner]
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,119 @@
1
+ Metadata-Version: 2.4
2
+ Name: evo-agents-core-plugins
3
+ Version: 1.0.0
4
+ Summary: The first-party core plugins of the evo-agents hub: Telegram and the chat history in the knowledge graph
5
+ Author: maycuatroi
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Repository, https://github.com/maycuatroi1/evo-agents-core-plugins
8
+ Keywords: agents,evo-agents,hub,plugins,telegram
9
+ Classifier: Development Status :: 3 - Alpha
10
+ Classifier: Programming Language :: Python :: 3 :: Only
11
+ Classifier: Topic :: Software Development
12
+ Requires-Python: >=3.11
13
+ Description-Content-Type: text/markdown
14
+ License-File: LICENSE
15
+ Dynamic: license-file
16
+
17
+ # evo-agents-core-plugins
18
+
19
+ The first-party core plugins of the [evo-agents](https://github.com/maycuatroi1/evo-agents) hub, out of evo-agents
20
+ and built on its API of core plugins alone (`evo_agents.hub.server.core_plugin_api`):
21
+
22
+ | Plugin | Package | What it does |
23
+ |---|---|---|
24
+ | `telegram` | `evo_core_plugins.telegram` | The hub's Telegram channel: a member links a private chat from the web, gets decisions, proposals and notices there, and answers them with buttons or replies |
25
+ | `chats` | `evo_core_plugins.chats` | The messages of the hub's group chats in each project's knowledge graph, for who is in each chat |
26
+
27
+ Both left evo-ak unchanged for their users: the same id, publisher (`evo-agents`) and entry point name, the same
28
+ routes, webhook path and variables (`EVO_HUB_TELEGRAM_*`), the same item ids (`plugin.chats:...`). Their manifests
29
+ moved to version 1.1.0, so the hub's store records a new version of the image's plugins.
30
+
31
+ ## How the hub installs it
32
+
33
+ One distribution, `evo-agents-core-plugins`, with one entry point per plugin in group `evo_agents.plugins`. The hub's
34
+ image installs it from PyPI with `--no-deps --require-hashes`, from the line `deploy/hub/core-plugins.txt` of
35
+ evo-agents pins:
36
+
37
+ ```
38
+ evo-agents-core-plugins==1.0.0 --hash=sha256:<the hash the release prints>
39
+ ```
40
+
41
+ The wheel declares no dependency: the plugins use only what the image of the hub already holds (evo-ak with its
42
+ `hub-server` extra: FastAPI, pydantic, httpx). Declaring evo-ak would let a resolver pull evo-ak from PyPI over the
43
+ one the image builds from evo-agents' main. `plugin_tests/test_packaging.py` keeps both.
44
+
45
+ ## The API of core plugins
46
+
47
+ A plugin imports `evo_agents.hub.server.core_plugin_api` and nothing else of evo_agents, imports no SQLAlchemy, and
48
+ reaches its own modules with relative imports (`plugin_tests/test_api_imports.py`, a copy of evo-agents'
49
+ `tests/plugins/test_core_plugin_imports.py`). No plugin imports another (`lint-imports`, contract
50
+ `plugins-own-package`). Neither the plugins nor their tests hold raw SQL (`plugin_tests/test_no_raw_sql.py`).
51
+
52
+ Each plugin's entry point names `manifest()`, which calls `hub.require(*API)` with the version of the API the plugin
53
+ is written for. A hub serves exactly one `major.minor`: a hub that serves another leaves the plugin out with the reason
54
+ (`core plugin not loaded`), and the `check` its Dockerfile runs fails the build. Every plugin of one release asks for
55
+ the same version, which `python -m evo_core_plugins api` prints; `python -m evo_agents.hub.server.core_plugin_api
56
+ version` prints the one a checkout of evo-agents serves. `docs/plugins.md` of evo-agents has the rules and the table of
57
+ versions.
58
+
59
+ | This distribution | API it asks for | evo-agents commit that serves it |
60
+ |---|---|---|
61
+ | 1.0.0 | 1.1 | `ad12d3ccbee695a6915b22f4512f11794f7944fb` (pull request #106) |
62
+
63
+ ### A change of the API
64
+
65
+ 1. A pull request of evo-agents changes the API and its version. Its CI fails where the pinned release asks for the
66
+ old one.
67
+ 2. A pull request here moves `API` of every plugin to the new version, uses what changed, and sets `evo-agents.lock` to
68
+ the head commit of that evo-agents pull request, so CI runs against it. evo-agents merges with merge commits, so the
69
+ commit stays in main's history.
70
+ 3. Merge, bump `evo_core_plugins.__version__`, tag `v<version>`: the release publishes it.
71
+ 4. The evo-agents pull request pins the new release with its hash; its CI turns green.
72
+
73
+ The nightly `compat` job tells early when main serves a version these plugins do not ask for.
74
+
75
+ ## Development
76
+
77
+ You need `uv`, git and, for the tests that start a hub, Postgres.
78
+
79
+ ```sh
80
+ make setup # evo-agents at the commit of evo-agents.lock in .evo-agents, a venv in .venv with both, editable
81
+ make check # ruff, import-linter, the import, raw SQL and packaging checks
82
+ make test # every test; the hub's need EVO_HUB_TEST_DSN, such as postgresql://postgres:test@localhost:5432/postgres
83
+ ```
84
+
85
+ `make setup EVO_AGENTS_URL=~/github/evo-agents` fetches from a local clone instead of GitHub, `EVO_AGENTS_REF=main`
86
+ checks out main instead of the lock, and `make lock` says whether `.evo-agents` is at the lock.
87
+
88
+ ## Tests
89
+
90
+ `plugin_tests/test_telegram.py`, `test_telegram_model.py`, `fake_telegram.py` and `test_chats_kg_source.py` are the
91
+ tests these plugins had in evo-agents. They use evo-agents' test helpers from the checkout at the lock: `tests.hub.pg`,
92
+ `tests.hub.live`, the fixtures of `tests/hub/conftest.py` and functions of its test modules (`conftest.py` puts the
93
+ checkout on `sys.path` and loads them). **These helpers are not part of the API of core plugins.** No wheel holds them
94
+ and no version covers them: evo-agents may change one without changing the API's version, and the tests here then
95
+ break at the next move of the lock or in the compat job, never on a hub.
96
+
97
+ The directory is `plugin_tests`, not `tests`, so that evo-agents' `tests` package stays importable. Until evo-agents
98
+ drops its own copies of `telegram` and `chats`, the evo-ak the tests install declares entry points of the same names;
99
+ `plugin_tests/conftest.py` leaves those out, so the hub the tests start loads this checkout's plugins, and
100
+ `plugin_tests/test_installed.py` checks that it does.
101
+
102
+ ## CI and releases
103
+
104
+ - `ci.yml`, on pull requests and main: `make check`, and `make test` against a Postgres service, with evo-agents at the
105
+ lock.
106
+ - `compat.yml`, every night and by hand: the same tests against evo-agents' main, after comparing the API main serves
107
+ with the one the plugins ask for. A failure opens an issue labelled `compat`, or comments on the open one.
108
+ - `release.yml`, on a tag `v<version>` that matches `evo_core_plugins.__version__`: `ci.yml`, then the wheel and sdist,
109
+ published to PyPI by trusted publishing in the environment `pypi` (a reviewer approves it). The run's summary holds
110
+ the line to pin in evo-agents, with the wheel's sha256.
111
+
112
+ ## Names
113
+
114
+ This repository is public, like evo-agents: tests, fixtures, docs and commit messages use made-up names only (such as
115
+ northwind and lumen), never a customer's.
116
+
117
+ ## License
118
+
119
+ Apache-2.0, as evo-agents.
@@ -0,0 +1,103 @@
1
+ # evo-agents-core-plugins
2
+
3
+ The first-party core plugins of the [evo-agents](https://github.com/maycuatroi1/evo-agents) hub, out of evo-agents
4
+ and built on its API of core plugins alone (`evo_agents.hub.server.core_plugin_api`):
5
+
6
+ | Plugin | Package | What it does |
7
+ |---|---|---|
8
+ | `telegram` | `evo_core_plugins.telegram` | The hub's Telegram channel: a member links a private chat from the web, gets decisions, proposals and notices there, and answers them with buttons or replies |
9
+ | `chats` | `evo_core_plugins.chats` | The messages of the hub's group chats in each project's knowledge graph, for who is in each chat |
10
+
11
+ Both left evo-ak unchanged for their users: the same id, publisher (`evo-agents`) and entry point name, the same
12
+ routes, webhook path and variables (`EVO_HUB_TELEGRAM_*`), the same item ids (`plugin.chats:...`). Their manifests
13
+ moved to version 1.1.0, so the hub's store records a new version of the image's plugins.
14
+
15
+ ## How the hub installs it
16
+
17
+ One distribution, `evo-agents-core-plugins`, with one entry point per plugin in group `evo_agents.plugins`. The hub's
18
+ image installs it from PyPI with `--no-deps --require-hashes`, from the line `deploy/hub/core-plugins.txt` of
19
+ evo-agents pins:
20
+
21
+ ```
22
+ evo-agents-core-plugins==1.0.0 --hash=sha256:<the hash the release prints>
23
+ ```
24
+
25
+ The wheel declares no dependency: the plugins use only what the image of the hub already holds (evo-ak with its
26
+ `hub-server` extra: FastAPI, pydantic, httpx). Declaring evo-ak would let a resolver pull evo-ak from PyPI over the
27
+ one the image builds from evo-agents' main. `plugin_tests/test_packaging.py` keeps both.
28
+
29
+ ## The API of core plugins
30
+
31
+ A plugin imports `evo_agents.hub.server.core_plugin_api` and nothing else of evo_agents, imports no SQLAlchemy, and
32
+ reaches its own modules with relative imports (`plugin_tests/test_api_imports.py`, a copy of evo-agents'
33
+ `tests/plugins/test_core_plugin_imports.py`). No plugin imports another (`lint-imports`, contract
34
+ `plugins-own-package`). Neither the plugins nor their tests hold raw SQL (`plugin_tests/test_no_raw_sql.py`).
35
+
36
+ Each plugin's entry point names `manifest()`, which calls `hub.require(*API)` with the version of the API the plugin
37
+ is written for. A hub serves exactly one `major.minor`: a hub that serves another leaves the plugin out with the reason
38
+ (`core plugin not loaded`), and the `check` its Dockerfile runs fails the build. Every plugin of one release asks for
39
+ the same version, which `python -m evo_core_plugins api` prints; `python -m evo_agents.hub.server.core_plugin_api
40
+ version` prints the one a checkout of evo-agents serves. `docs/plugins.md` of evo-agents has the rules and the table of
41
+ versions.
42
+
43
+ | This distribution | API it asks for | evo-agents commit that serves it |
44
+ |---|---|---|
45
+ | 1.0.0 | 1.1 | `ad12d3ccbee695a6915b22f4512f11794f7944fb` (pull request #106) |
46
+
47
+ ### A change of the API
48
+
49
+ 1. A pull request of evo-agents changes the API and its version. Its CI fails where the pinned release asks for the
50
+ old one.
51
+ 2. A pull request here moves `API` of every plugin to the new version, uses what changed, and sets `evo-agents.lock` to
52
+ the head commit of that evo-agents pull request, so CI runs against it. evo-agents merges with merge commits, so the
53
+ commit stays in main's history.
54
+ 3. Merge, bump `evo_core_plugins.__version__`, tag `v<version>`: the release publishes it.
55
+ 4. The evo-agents pull request pins the new release with its hash; its CI turns green.
56
+
57
+ The nightly `compat` job tells early when main serves a version these plugins do not ask for.
58
+
59
+ ## Development
60
+
61
+ You need `uv`, git and, for the tests that start a hub, Postgres.
62
+
63
+ ```sh
64
+ make setup # evo-agents at the commit of evo-agents.lock in .evo-agents, a venv in .venv with both, editable
65
+ make check # ruff, import-linter, the import, raw SQL and packaging checks
66
+ make test # every test; the hub's need EVO_HUB_TEST_DSN, such as postgresql://postgres:test@localhost:5432/postgres
67
+ ```
68
+
69
+ `make setup EVO_AGENTS_URL=~/github/evo-agents` fetches from a local clone instead of GitHub, `EVO_AGENTS_REF=main`
70
+ checks out main instead of the lock, and `make lock` says whether `.evo-agents` is at the lock.
71
+
72
+ ## Tests
73
+
74
+ `plugin_tests/test_telegram.py`, `test_telegram_model.py`, `fake_telegram.py` and `test_chats_kg_source.py` are the
75
+ tests these plugins had in evo-agents. They use evo-agents' test helpers from the checkout at the lock: `tests.hub.pg`,
76
+ `tests.hub.live`, the fixtures of `tests/hub/conftest.py` and functions of its test modules (`conftest.py` puts the
77
+ checkout on `sys.path` and loads them). **These helpers are not part of the API of core plugins.** No wheel holds them
78
+ and no version covers them: evo-agents may change one without changing the API's version, and the tests here then
79
+ break at the next move of the lock or in the compat job, never on a hub.
80
+
81
+ The directory is `plugin_tests`, not `tests`, so that evo-agents' `tests` package stays importable. Until evo-agents
82
+ drops its own copies of `telegram` and `chats`, the evo-ak the tests install declares entry points of the same names;
83
+ `plugin_tests/conftest.py` leaves those out, so the hub the tests start loads this checkout's plugins, and
84
+ `plugin_tests/test_installed.py` checks that it does.
85
+
86
+ ## CI and releases
87
+
88
+ - `ci.yml`, on pull requests and main: `make check`, and `make test` against a Postgres service, with evo-agents at the
89
+ lock.
90
+ - `compat.yml`, every night and by hand: the same tests against evo-agents' main, after comparing the API main serves
91
+ with the one the plugins ask for. A failure opens an issue labelled `compat`, or comments on the open one.
92
+ - `release.yml`, on a tag `v<version>` that matches `evo_core_plugins.__version__`: `ci.yml`, then the wheel and sdist,
93
+ published to PyPI by trusted publishing in the environment `pypi` (a reviewer approves it). The run's summary holds
94
+ the line to pin in evo-agents, with the wheel's sha256.
95
+
96
+ ## Names
97
+
98
+ This repository is public, like evo-agents: tests, fixtures, docs and commit messages use made-up names only (such as
99
+ northwind and lumen), never a customer's.
100
+
101
+ ## License
102
+
103
+ Apache-2.0, as evo-agents.
@@ -0,0 +1,119 @@
1
+ Metadata-Version: 2.4
2
+ Name: evo-agents-core-plugins
3
+ Version: 1.0.0
4
+ Summary: The first-party core plugins of the evo-agents hub: Telegram and the chat history in the knowledge graph
5
+ Author: maycuatroi
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Repository, https://github.com/maycuatroi1/evo-agents-core-plugins
8
+ Keywords: agents,evo-agents,hub,plugins,telegram
9
+ Classifier: Development Status :: 3 - Alpha
10
+ Classifier: Programming Language :: Python :: 3 :: Only
11
+ Classifier: Topic :: Software Development
12
+ Requires-Python: >=3.11
13
+ Description-Content-Type: text/markdown
14
+ License-File: LICENSE
15
+ Dynamic: license-file
16
+
17
+ # evo-agents-core-plugins
18
+
19
+ The first-party core plugins of the [evo-agents](https://github.com/maycuatroi1/evo-agents) hub, out of evo-agents
20
+ and built on its API of core plugins alone (`evo_agents.hub.server.core_plugin_api`):
21
+
22
+ | Plugin | Package | What it does |
23
+ |---|---|---|
24
+ | `telegram` | `evo_core_plugins.telegram` | The hub's Telegram channel: a member links a private chat from the web, gets decisions, proposals and notices there, and answers them with buttons or replies |
25
+ | `chats` | `evo_core_plugins.chats` | The messages of the hub's group chats in each project's knowledge graph, for who is in each chat |
26
+
27
+ Both left evo-ak unchanged for their users: the same id, publisher (`evo-agents`) and entry point name, the same
28
+ routes, webhook path and variables (`EVO_HUB_TELEGRAM_*`), the same item ids (`plugin.chats:...`). Their manifests
29
+ moved to version 1.1.0, so the hub's store records a new version of the image's plugins.
30
+
31
+ ## How the hub installs it
32
+
33
+ One distribution, `evo-agents-core-plugins`, with one entry point per plugin in group `evo_agents.plugins`. The hub's
34
+ image installs it from PyPI with `--no-deps --require-hashes`, from the line `deploy/hub/core-plugins.txt` of
35
+ evo-agents pins:
36
+
37
+ ```
38
+ evo-agents-core-plugins==1.0.0 --hash=sha256:<the hash the release prints>
39
+ ```
40
+
41
+ The wheel declares no dependency: the plugins use only what the image of the hub already holds (evo-ak with its
42
+ `hub-server` extra: FastAPI, pydantic, httpx). Declaring evo-ak would let a resolver pull evo-ak from PyPI over the
43
+ one the image builds from evo-agents' main. `plugin_tests/test_packaging.py` keeps both.
44
+
45
+ ## The API of core plugins
46
+
47
+ A plugin imports `evo_agents.hub.server.core_plugin_api` and nothing else of evo_agents, imports no SQLAlchemy, and
48
+ reaches its own modules with relative imports (`plugin_tests/test_api_imports.py`, a copy of evo-agents'
49
+ `tests/plugins/test_core_plugin_imports.py`). No plugin imports another (`lint-imports`, contract
50
+ `plugins-own-package`). Neither the plugins nor their tests hold raw SQL (`plugin_tests/test_no_raw_sql.py`).
51
+
52
+ Each plugin's entry point names `manifest()`, which calls `hub.require(*API)` with the version of the API the plugin
53
+ is written for. A hub serves exactly one `major.minor`: a hub that serves another leaves the plugin out with the reason
54
+ (`core plugin not loaded`), and the `check` its Dockerfile runs fails the build. Every plugin of one release asks for
55
+ the same version, which `python -m evo_core_plugins api` prints; `python -m evo_agents.hub.server.core_plugin_api
56
+ version` prints the one a checkout of evo-agents serves. `docs/plugins.md` of evo-agents has the rules and the table of
57
+ versions.
58
+
59
+ | This distribution | API it asks for | evo-agents commit that serves it |
60
+ |---|---|---|
61
+ | 1.0.0 | 1.1 | `ad12d3ccbee695a6915b22f4512f11794f7944fb` (pull request #106) |
62
+
63
+ ### A change of the API
64
+
65
+ 1. A pull request of evo-agents changes the API and its version. Its CI fails where the pinned release asks for the
66
+ old one.
67
+ 2. A pull request here moves `API` of every plugin to the new version, uses what changed, and sets `evo-agents.lock` to
68
+ the head commit of that evo-agents pull request, so CI runs against it. evo-agents merges with merge commits, so the
69
+ commit stays in main's history.
70
+ 3. Merge, bump `evo_core_plugins.__version__`, tag `v<version>`: the release publishes it.
71
+ 4. The evo-agents pull request pins the new release with its hash; its CI turns green.
72
+
73
+ The nightly `compat` job tells early when main serves a version these plugins do not ask for.
74
+
75
+ ## Development
76
+
77
+ You need `uv`, git and, for the tests that start a hub, Postgres.
78
+
79
+ ```sh
80
+ make setup # evo-agents at the commit of evo-agents.lock in .evo-agents, a venv in .venv with both, editable
81
+ make check # ruff, import-linter, the import, raw SQL and packaging checks
82
+ make test # every test; the hub's need EVO_HUB_TEST_DSN, such as postgresql://postgres:test@localhost:5432/postgres
83
+ ```
84
+
85
+ `make setup EVO_AGENTS_URL=~/github/evo-agents` fetches from a local clone instead of GitHub, `EVO_AGENTS_REF=main`
86
+ checks out main instead of the lock, and `make lock` says whether `.evo-agents` is at the lock.
87
+
88
+ ## Tests
89
+
90
+ `plugin_tests/test_telegram.py`, `test_telegram_model.py`, `fake_telegram.py` and `test_chats_kg_source.py` are the
91
+ tests these plugins had in evo-agents. They use evo-agents' test helpers from the checkout at the lock: `tests.hub.pg`,
92
+ `tests.hub.live`, the fixtures of `tests/hub/conftest.py` and functions of its test modules (`conftest.py` puts the
93
+ checkout on `sys.path` and loads them). **These helpers are not part of the API of core plugins.** No wheel holds them
94
+ and no version covers them: evo-agents may change one without changing the API's version, and the tests here then
95
+ break at the next move of the lock or in the compat job, never on a hub.
96
+
97
+ The directory is `plugin_tests`, not `tests`, so that evo-agents' `tests` package stays importable. Until evo-agents
98
+ drops its own copies of `telegram` and `chats`, the evo-ak the tests install declares entry points of the same names;
99
+ `plugin_tests/conftest.py` leaves those out, so the hub the tests start loads this checkout's plugins, and
100
+ `plugin_tests/test_installed.py` checks that it does.
101
+
102
+ ## CI and releases
103
+
104
+ - `ci.yml`, on pull requests and main: `make check`, and `make test` against a Postgres service, with evo-agents at the
105
+ lock.
106
+ - `compat.yml`, every night and by hand: the same tests against evo-agents' main, after comparing the API main serves
107
+ with the one the plugins ask for. A failure opens an issue labelled `compat`, or comments on the open one.
108
+ - `release.yml`, on a tag `v<version>` that matches `evo_core_plugins.__version__`: `ci.yml`, then the wheel and sdist,
109
+ published to PyPI by trusted publishing in the environment `pypi` (a reviewer approves it). The run's summary holds
110
+ the line to pin in evo-agents, with the wheel's sha256.
111
+
112
+ ## Names
113
+
114
+ This repository is public, like evo-agents: tests, fixtures, docs and commit messages use made-up names only (such as
115
+ northwind and lumen), never a customer's.
116
+
117
+ ## License
118
+
119
+ Apache-2.0, as evo-agents.
@@ -0,0 +1,15 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ evo_agents_core_plugins.egg-info/PKG-INFO
5
+ evo_agents_core_plugins.egg-info/SOURCES.txt
6
+ evo_agents_core_plugins.egg-info/dependency_links.txt
7
+ evo_agents_core_plugins.egg-info/entry_points.txt
8
+ evo_agents_core_plugins.egg-info/top_level.txt
9
+ evo_core_plugins/__init__.py
10
+ evo_core_plugins/__main__.py
11
+ evo_core_plugins/chats/__init__.py
12
+ evo_core_plugins/chats/kg.py
13
+ evo_core_plugins/telegram/__init__.py
14
+ evo_core_plugins/telegram/model.py
15
+ evo_core_plugins/telegram/server.py
@@ -0,0 +1,3 @@
1
+ [evo_agents.plugins]
2
+ chats = evo_core_plugins.chats:manifest
3
+ telegram = evo_core_plugins.telegram:manifest
@@ -0,0 +1,17 @@
1
+ """evo-agents-core-plugins: the first-party core plugins of the evo-agents hub, each a package of its own here
2
+ (``telegram``, ``chats``) and an entry point of group ``evo_agents.plugins``, built on the API of core plugins alone
3
+ (``evo_agents.hub.server.core_plugin_api``).
4
+
5
+ The hub's image installs this distribution with ``--no-deps`` from the line ``deploy/hub/core-plugins.txt`` of
6
+ evo-agents pins: it declares no dependency and uses only what the image of the hub already holds. Each plugin asks for
7
+ the version of the API it is written for in its ``manifest``; ``python -m evo_core_plugins api`` prints that version,
8
+ which every plugin of one release shares.
9
+
10
+ Nothing here imports another plugin's package: ``PLUGINS`` names them for the checks and the command alone.
11
+ """
12
+
13
+ __version__ = "1.0.0"
14
+
15
+ PLUGINS = ("telegram", "chats") # the packages of the plugins, each named as its entry point
16
+
17
+ __all__ = ["PLUGINS", "__version__"]
@@ -0,0 +1,54 @@
1
+ """``python -m evo_core_plugins api`` prints the version of the API of core plugins the plugins of this release are
2
+ written for, ``major.minor``, as ``python -m evo_agents.hub.server.core_plugin_api version`` prints the version a
3
+ checkout of evo-agents serves; the compat job of CI compares the two. It exits 1 when two plugins ask for different
4
+ versions, which one release must not do.
5
+
6
+ The version is read from each plugin's source (the assignment ``API = (major, minor)`` of its ``__init__``), without
7
+ importing it, so the command runs where evo-agents is not installed.
8
+ """
9
+
10
+ from __future__ import annotations
11
+
12
+ import ast
13
+ import sys
14
+ from pathlib import Path
15
+
16
+ from evo_core_plugins import PLUGINS
17
+
18
+ USAGE = "usage: python -m evo_core_plugins api"
19
+ HERE = Path(__file__).resolve().parent
20
+
21
+
22
+ def required(plugin: str, root: Path = HERE) -> tuple[int, int]:
23
+ """The version of the API plugin ``plugin`` asks for, read from ``API = (major, minor)`` in its ``__init__``."""
24
+ init = root / plugin / "__init__.py"
25
+ for node in ast.parse(init.read_text(encoding="utf-8"), filename=str(init)).body:
26
+ if isinstance(node, ast.Assign) and any(getattr(target, "id", None) == "API" for target in node.targets):
27
+ value = ast.literal_eval(node.value)
28
+ if isinstance(value, tuple) and len(value) == 2 and all(type(part) is int for part in value):
29
+ return value
30
+ raise ValueError(f"{init}: API is {value!r}, not (major, minor)")
31
+ raise ValueError(f"{init} assigns no API = (major, minor)")
32
+
33
+
34
+ def versions(root: Path = HERE) -> dict[str, tuple[int, int]]:
35
+ """plugin -> the version of the API it asks for, for every plugin of PLUGINS."""
36
+ return {plugin: required(plugin, root) for plugin in PLUGINS}
37
+
38
+
39
+ def main(argv: list[str], root: Path | None = None) -> int:
40
+ if argv != ["api"]:
41
+ sys.stderr.write(USAGE + "\n")
42
+ return 2
43
+ found = versions(HERE if root is None else root)
44
+ if len(set(found.values())) != 1:
45
+ listed = ", ".join(f"{plugin} {major}.{minor}" for plugin, (major, minor) in found.items())
46
+ sys.stderr.write(f"the plugins of one release ask for different versions of the API: {listed}\n")
47
+ return 1
48
+ major, minor = next(iter(found.values()))
49
+ sys.stdout.write(f"{major}.{minor}\n")
50
+ return 0
51
+
52
+
53
+ if __name__ == "__main__":
54
+ sys.exit(main(sys.argv[1:]))