awask 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.
- awask-0.1.0/.github/workflows/pypi-publish.yml +33 -0
- awask-0.1.0/.gitignore +17 -0
- awask-0.1.0/LICENSE +202 -0
- awask-0.1.0/PKG-INFO +368 -0
- awask-0.1.0/README.md +143 -0
- awask-0.1.0/aither-manifest.json +20 -0
- awask-0.1.0/awask/__init__.py +79 -0
- awask-0.1.0/awask/_doctor.py +139 -0
- awask-0.1.0/awask/agent_tools.py +473 -0
- awask-0.1.0/awask/channels.py +600 -0
- awask-0.1.0/awask/cli.py +763 -0
- awask-0.1.0/awask/context.py +503 -0
- awask-0.1.0/awask/entry.py +36 -0
- awask-0.1.0/awask/hooks/__init__.py +0 -0
- awask-0.1.0/awask/hooks/awask_mailbox_drain.py +242 -0
- awask-0.1.0/awask/hooks/awask_notification_card.py +331 -0
- awask-0.1.0/awask/hooks/stop_awask_cards.py +203 -0
- awask-0.1.0/awask/install.py +302 -0
- awask-0.1.0/awask/notify.py +376 -0
- awask-0.1.0/awask/popup.py +1740 -0
- awask-0.1.0/awask/presence.py +166 -0
- awask-0.1.0/awask/render.py +305 -0
- awask-0.1.0/awask/steerback.py +221 -0
- awask-0.1.0/awask/store.py +873 -0
- awask-0.1.0/awask/terminal.py +557 -0
- awask-0.1.0/awask/winproc.py +367 -0
- awask-0.1.0/pyproject.toml +60 -0
- awask-0.1.0/scripts/check_moat_boundary.py +250 -0
- awask-0.1.0/tests/test_lint_config_agrees.py +60 -0
- awask-0.1.0/tests/test_store.py +162 -0
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
name: Publish to PyPI
|
|
2
|
+
on:
|
|
3
|
+
release:
|
|
4
|
+
types: [published]
|
|
5
|
+
workflow_dispatch:
|
|
6
|
+
permissions:
|
|
7
|
+
id-token: write
|
|
8
|
+
contents: read
|
|
9
|
+
jobs:
|
|
10
|
+
publish:
|
|
11
|
+
runs-on: ubuntu-latest
|
|
12
|
+
environment: pypi
|
|
13
|
+
steps:
|
|
14
|
+
- uses: actions/checkout@v4
|
|
15
|
+
- uses: actions/setup-python@v5
|
|
16
|
+
with:
|
|
17
|
+
python-version: "3.12"
|
|
18
|
+
- name: Install package + test tools
|
|
19
|
+
run: |
|
|
20
|
+
pip install build
|
|
21
|
+
pip install -e .
|
|
22
|
+
pip install pytest pytest-asyncio pytest-timeout
|
|
23
|
+
- name: Run the test suite before publishing
|
|
24
|
+
run: python -m pytest tests/ -q --timeout=180
|
|
25
|
+
- name: Build package
|
|
26
|
+
run: python -m build
|
|
27
|
+
- name: Moat guard (inspect built wheel + sdist)
|
|
28
|
+
run: python scripts/check_moat_boundary.py
|
|
29
|
+
- name: Publish to PyPI
|
|
30
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
31
|
+
with:
|
|
32
|
+
packages-dir: dist/
|
|
33
|
+
skip-existing: true
|
awask-0.1.0/.gitignore
ADDED
awask-0.1.0/LICENSE
ADDED
|
@@ -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.
|
awask-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,368 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: awask
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Your agent asks you a question — and acts on your answer. Durable decision cards for agents: a structured ask, delivered wherever you are, whose answer steers the run that raised it.
|
|
5
|
+
Project-URL: Homepage, https://aitherium.com
|
|
6
|
+
Project-URL: Source, https://github.com/Aitherium/awask
|
|
7
|
+
Author-email: Aitherium <hello@aitherium.com>
|
|
8
|
+
License:
|
|
9
|
+
Apache License
|
|
10
|
+
Version 2.0, January 2004
|
|
11
|
+
http://www.apache.org/licenses/
|
|
12
|
+
|
|
13
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
14
|
+
|
|
15
|
+
1. Definitions.
|
|
16
|
+
|
|
17
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
18
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
19
|
+
|
|
20
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
21
|
+
the copyright owner that is granting the License.
|
|
22
|
+
|
|
23
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
24
|
+
other entities that control, are controlled by, or are under common
|
|
25
|
+
control with that entity. For the purposes of this definition,
|
|
26
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
27
|
+
direction or management of such entity, whether by contract or
|
|
28
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
29
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
30
|
+
|
|
31
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
32
|
+
exercising permissions granted by this License.
|
|
33
|
+
|
|
34
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
35
|
+
including but not limited to software source code, documentation
|
|
36
|
+
source, and configuration files.
|
|
37
|
+
|
|
38
|
+
"Object" form shall mean any form resulting from mechanical
|
|
39
|
+
transformation or translation of a Source form, including but
|
|
40
|
+
not limited to compiled object code, generated documentation,
|
|
41
|
+
and conversions to other media types.
|
|
42
|
+
|
|
43
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
44
|
+
Object form, made available under the License, as indicated by a
|
|
45
|
+
copyright notice that is included in or attached to the work
|
|
46
|
+
(an example is provided in the Appendix below).
|
|
47
|
+
|
|
48
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
49
|
+
form, that is based on (or derived from) the Work and for which the
|
|
50
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
51
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
52
|
+
of this License, Derivative Works shall not include works that remain
|
|
53
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
54
|
+
the Work and Derivative Works thereof.
|
|
55
|
+
|
|
56
|
+
"Contribution" shall mean any work of authorship, including
|
|
57
|
+
the original version of the Work and any modifications or additions
|
|
58
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
59
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
60
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
61
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
62
|
+
means any form of electronic, verbal, or written communication sent
|
|
63
|
+
to the Licensor or its representatives, including but not limited to
|
|
64
|
+
communication on electronic mailing lists, source code control systems,
|
|
65
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
66
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
67
|
+
excluding communication that is conspicuously marked or otherwise
|
|
68
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
69
|
+
|
|
70
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
71
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
72
|
+
subsequently incorporated within the Work.
|
|
73
|
+
|
|
74
|
+
2. Grant of Copyright 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
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
78
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
79
|
+
Work and such Derivative Works in Source or Object form.
|
|
80
|
+
|
|
81
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
82
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
83
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
84
|
+
(except as stated in this section) patent license to make, have made,
|
|
85
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
86
|
+
where such license applies only to those patent claims licensable
|
|
87
|
+
by such Contributor that are necessarily infringed by their
|
|
88
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
89
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
90
|
+
institute patent litigation against any entity (including a
|
|
91
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
92
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
93
|
+
or contributory patent infringement, then any patent licenses
|
|
94
|
+
granted to You under this License for that Work shall terminate
|
|
95
|
+
as of the date such litigation is filed.
|
|
96
|
+
|
|
97
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
98
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
99
|
+
modifications, and in Source or Object form, provided that You
|
|
100
|
+
meet the following conditions:
|
|
101
|
+
|
|
102
|
+
(a) You must give any other recipients of the Work or
|
|
103
|
+
Derivative Works a copy of this License; and
|
|
104
|
+
|
|
105
|
+
(b) You must cause any modified files to carry prominent notices
|
|
106
|
+
stating that You changed the files; and
|
|
107
|
+
|
|
108
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
109
|
+
that You distribute, all copyright, patent, trademark, and
|
|
110
|
+
attribution notices from the Source form of the Work,
|
|
111
|
+
excluding those notices that do not pertain to any part of
|
|
112
|
+
the Derivative Works; and
|
|
113
|
+
|
|
114
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
115
|
+
distribution, then any Derivative Works that You distribute must
|
|
116
|
+
include a readable copy of the attribution notices contained
|
|
117
|
+
within such NOTICE file, excluding those notices that do not
|
|
118
|
+
pertain to any part of the Derivative Works, in at least one
|
|
119
|
+
of the following places: within a NOTICE text file distributed
|
|
120
|
+
as part of the Derivative Works; within the Source form or
|
|
121
|
+
documentation, if provided along with the Derivative Works; or,
|
|
122
|
+
within a display generated by the Derivative Works, if and
|
|
123
|
+
wherever such third-party notices normally appear. The contents
|
|
124
|
+
of the NOTICE file are for informational purposes only and
|
|
125
|
+
do not modify the License. You may add Your own attribution
|
|
126
|
+
notices within Derivative Works that You distribute, alongside
|
|
127
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
128
|
+
that such additional attribution notices cannot be construed
|
|
129
|
+
as modifying the License.
|
|
130
|
+
|
|
131
|
+
You may add Your own copyright statement to Your modifications and
|
|
132
|
+
may provide additional or different license terms and conditions
|
|
133
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
134
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
135
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
136
|
+
the conditions stated in this License.
|
|
137
|
+
|
|
138
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
139
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
140
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
141
|
+
this License, without any additional terms or conditions.
|
|
142
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
143
|
+
the terms of any separate license agreement you may have executed
|
|
144
|
+
with Licensor regarding such Contributions.
|
|
145
|
+
|
|
146
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
147
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
148
|
+
except as required for reasonable and customary use in describing the
|
|
149
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
150
|
+
|
|
151
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
152
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
153
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
154
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
155
|
+
implied, including, without limitation, any warranties or conditions
|
|
156
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
157
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
158
|
+
appropriateness of using or redistributing the Work and assume any
|
|
159
|
+
risks associated with Your exercise of permissions under this License.
|
|
160
|
+
|
|
161
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
162
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
163
|
+
unless required by applicable law (such as deliberate and grossly
|
|
164
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
165
|
+
liable to You for damages, including any direct, indirect, special,
|
|
166
|
+
incidental, or consequential damages of any character arising as a
|
|
167
|
+
result of this License or out of the use or inability to use the
|
|
168
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
169
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
170
|
+
other commercial damages or losses), even if such Contributor
|
|
171
|
+
has been advised of the possibility of such damages.
|
|
172
|
+
|
|
173
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
174
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
175
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
176
|
+
or other liability obligations and/or rights consistent with this
|
|
177
|
+
License. However, in accepting such obligations, You may act only
|
|
178
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
179
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
180
|
+
defend, and hold each Contributor harmless for any liability
|
|
181
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
182
|
+
of your accepting any such warranty or additional liability.
|
|
183
|
+
|
|
184
|
+
END OF TERMS AND CONDITIONS
|
|
185
|
+
|
|
186
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
187
|
+
|
|
188
|
+
To apply the Apache License to your work, attach the following
|
|
189
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
190
|
+
replaced with your own identifying information. (Don't include
|
|
191
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
192
|
+
comment syntax for the file format. We also recommend that a
|
|
193
|
+
file or class name and description of purpose be included on the
|
|
194
|
+
same "printed page" as the copyright notice for easier
|
|
195
|
+
identification within third-party archives.
|
|
196
|
+
|
|
197
|
+
Copyright [yyyy] [name of copyright owner]
|
|
198
|
+
|
|
199
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
200
|
+
you may not use this file except in compliance with the License.
|
|
201
|
+
You may obtain a copy of the License at
|
|
202
|
+
|
|
203
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
204
|
+
|
|
205
|
+
Unless required by applicable law or agreed to in writing, software
|
|
206
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
207
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
208
|
+
See the License for the specific language governing permissions and
|
|
209
|
+
limitations under the License.
|
|
210
|
+
License-File: LICENSE
|
|
211
|
+
Keywords: agents,approval,claude-code,cli,decisions,human-in-the-loop
|
|
212
|
+
Classifier: Development Status :: 4 - Beta
|
|
213
|
+
Classifier: Intended Audience :: Developers
|
|
214
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
215
|
+
Classifier: Programming Language :: Python :: 3
|
|
216
|
+
Classifier: Programming Language :: Python :: 3.9
|
|
217
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
218
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
219
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
220
|
+
Classifier: Topic :: Software Development :: Libraries
|
|
221
|
+
Requires-Python: >=3.9
|
|
222
|
+
Provides-Extra: chat
|
|
223
|
+
Requires-Dist: httpx>=0.25.0; extra == 'chat'
|
|
224
|
+
Description-Content-Type: text/markdown
|
|
225
|
+
|
|
226
|
+
# awask — your agent asks you a question, and acts on your answer
|
|
227
|
+
|
|
228
|
+
An agent that needs a human has one channel today: prose in a terminal. That channel
|
|
229
|
+
loses. The deciding sentence sits in paragraph four, you are in another window, and
|
|
230
|
+
the run sits idle for forty minutes because nothing told you it was waiting.
|
|
231
|
+
|
|
232
|
+
`awask` makes the ask a **thing** instead of a line of text: a small structured card
|
|
233
|
+
in a durable store, rendered by every surface, whose answer is carried back into the
|
|
234
|
+
run that raised it.
|
|
235
|
+
|
|
236
|
+
```bash
|
|
237
|
+
pip install awask
|
|
238
|
+
```
|
|
239
|
+
|
|
240
|
+
Python 3.9+. **Zero dependencies** — standard library only. The store is a directory
|
|
241
|
+
of JSON files, so this is the entire setup: no server, no login, no network, nothing
|
|
242
|
+
to start before it works.
|
|
243
|
+
|
|
244
|
+
## Ask something
|
|
245
|
+
|
|
246
|
+
```bash
|
|
247
|
+
awask ask "Ship the migration now, or hold for review?" \
|
|
248
|
+
--summary "Tests pass. The rollback path is untested." \
|
|
249
|
+
--fact "312 rows affected" \
|
|
250
|
+
--fact "rollback has never been run against prod data" \
|
|
251
|
+
--option "ship|Ship it|live in ~2 min, rollback unproven" \
|
|
252
|
+
--option "hold|Hold for review|no risk, blocks tonight's release" \
|
|
253
|
+
--recommend hold --default hold --urgency high
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
Returns immediately. Your agent keeps working; you answer at your own pace.
|
|
257
|
+
|
|
258
|
+
```bash
|
|
259
|
+
awask list # what is waiting on you
|
|
260
|
+
awask show <id> # one card in full
|
|
261
|
+
awask answer <id> hold # pick an option
|
|
262
|
+
awask steer <id> "check the FK constraint first" # guidance; card stays open
|
|
263
|
+
awask cancel <id> # withdraw it — you solved it yourself
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
Use `|` as the option separator, never `:` — a Windows path in a consequence
|
|
267
|
+
(`C:\data`) silently mangles with the colon form.
|
|
268
|
+
|
|
269
|
+
## Close the loop in Claude Code
|
|
270
|
+
|
|
271
|
+
The CLI alone gives you cards when an agent types the command, and delivers your
|
|
272
|
+
answer at your next prompt. To make it automatic:
|
|
273
|
+
|
|
274
|
+
```bash
|
|
275
|
+
awask install-hooks # this project
|
|
276
|
+
awask install-hooks --user # every project
|
|
277
|
+
awask install-hooks --dry-run
|
|
278
|
+
```
|
|
279
|
+
|
|
280
|
+
That writes three hooks and merges three entries into `settings.json`:
|
|
281
|
+
|
|
282
|
+
| event | hook | what it does |
|
|
283
|
+
|---|---|---|
|
|
284
|
+
| `Stop` | `stop_awask_cards.py` | holds the turn open ~50s so your answer resumes the run |
|
|
285
|
+
| `UserPromptSubmit` | `awask_mailbox_drain.py` | **carries your answer INTO the session** |
|
|
286
|
+
| `Notification` | `awask_notification_card.py` | "the agent is waiting" becomes a card |
|
|
287
|
+
|
|
288
|
+
**The middle one is the one people skip and the one that matters.** Without it you can
|
|
289
|
+
answer a card and the agent never learns you did — the card renders, you click, the
|
|
290
|
+
store records a resolution, and the run carries on as though nobody replied. Every
|
|
291
|
+
component reports success.
|
|
292
|
+
|
|
293
|
+
Your existing `settings.json` is **merged, never replaced**; re-running is a no-op;
|
|
294
|
+
a malformed settings file is refused rather than overwritten; and every hook is run
|
|
295
|
+
with `--self-test` after being written, because a copy is not an install.
|
|
296
|
+
|
|
297
|
+
## The five fields that make a card decidable
|
|
298
|
+
|
|
299
|
+
A card that cannot be answered from a phone lock screen is not finished.
|
|
300
|
+
|
|
301
|
+
1. **Title** — one line, the whole ask. If it needs two, raise two cards.
|
|
302
|
+
2. **Facts** — what you *measured*, not what you guess. Highest-value field here.
|
|
303
|
+
3. **Options** — each with a **consequence**. A label says what a choice is called; a
|
|
304
|
+
consequence says what happens to your machine. Only the consequence lets someone
|
|
305
|
+
decide without reading the code.
|
|
306
|
+
4. **`--recommend`** — say what you would do. A card with no recommendation pushes
|
|
307
|
+
your thinking onto the human.
|
|
308
|
+
5. **`--default`** — what happens if nobody ever answers. **Required**: a card is only
|
|
309
|
+
safe to ignore if it says what ignoring it does. An agent that cannot name a
|
|
310
|
+
default is not blocked on a decision, it is blocked on doing its own thinking.
|
|
311
|
+
|
|
312
|
+
## When to raise one — the bar is high
|
|
313
|
+
|
|
314
|
+
**A card is an interruption. The default is to keep working.** Raise one only when
|
|
315
|
+
all three hold:
|
|
316
|
+
|
|
317
|
+
1. The answers lead to **materially different work**, and
|
|
318
|
+
2. **A wrong guess costs real work** to undo — time, money, data, or something
|
|
319
|
+
outward-facing, and
|
|
320
|
+
3. **You cannot settle it yourself** by reading, measuring, or taking the
|
|
321
|
+
conventional default.
|
|
322
|
+
|
|
323
|
+
If any clause fails: decide it, say so in one line, keep going. "Should I continue?"
|
|
324
|
+
is the anti-pattern.
|
|
325
|
+
|
|
326
|
+
## From Python
|
|
327
|
+
|
|
328
|
+
```python
|
|
329
|
+
from awask import DecisionCard, DecisionOption, get_store
|
|
330
|
+
|
|
331
|
+
card = get_store().create(DecisionCard(
|
|
332
|
+
title="Two schema designs, both defensible",
|
|
333
|
+
options=[
|
|
334
|
+
DecisionOption(key="a", label="Single table", consequence="faster reads, wide rows"),
|
|
335
|
+
DecisionOption(key="b", label="Join table", consequence="normalized, extra hop"),
|
|
336
|
+
],
|
|
337
|
+
recommend="b", default="b",
|
|
338
|
+
))
|
|
339
|
+
print(card.id)
|
|
340
|
+
```
|
|
341
|
+
|
|
342
|
+
## Answering from elsewhere
|
|
343
|
+
|
|
344
|
+
`awask list/show/answer/cancel` read the store on local disk directly, so a fresh
|
|
345
|
+
install works with nothing running. Reaching those cards from another device — a
|
|
346
|
+
phone, a browser, a dashboard — needs a small local HTTP daemon serving the same
|
|
347
|
+
store, bound to loopback and fronted by a private tunnel or an authenticated proxy.
|
|
348
|
+
Never publish that port: it serves the queue that steers an agent with filesystem
|
|
349
|
+
access.
|
|
350
|
+
|
|
351
|
+
**Nothing starts that daemon for you, deliberately** — registering a background
|
|
352
|
+
service is a bigger ask than installing a CLI. The cost is worth naming: if it is
|
|
353
|
+
not running, remote surfaces have no cards to show, and an empty list looks exactly
|
|
354
|
+
like "nothing is waiting on you". A client that cannot reach it should say so.
|
|
355
|
+
|
|
356
|
+
## Delivery to a chat DM
|
|
357
|
+
|
|
358
|
+
`awask.channels` bridges cards to a Discord/Telegram/Slack **direct message** — your
|
|
359
|
+
bot, your token, bound to your user id. It is a DM bridge, not a channel bot, and
|
|
360
|
+
that is the entire security model: **a card answer steers an agent with filesystem
|
|
361
|
+
access**, so "who may answer" is an authorization decision. It fails closed at every
|
|
362
|
+
path — no config, no bound owner, a sender who is not the owner, or a message that
|
|
363
|
+
is not in a DM, all deny. A message in a public channel cannot answer a card even
|
|
364
|
+
when you typed it.
|
|
365
|
+
|
|
366
|
+
## Licence
|
|
367
|
+
|
|
368
|
+
Apache 2.0.
|