awscreen 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.
awscreen-1.0.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.
@@ -0,0 +1,91 @@
1
+ Metadata-Version: 2.4
2
+ Name: awscreen
3
+ Version: 1.0.0
4
+ Summary: Find elements on screen by describing what they look like
5
+ Author: Aither
6
+ License: MIT
7
+ Requires-Python: >=3.10
8
+ Description-Content-Type: text/markdown
9
+ License-File: LICENSE
10
+ Requires-Dist: Pillow>=10.0.0; platform_system == "Windows"
11
+ Provides-Extra: dev
12
+ Requires-Dist: pytest>=7.0; extra == "dev"
13
+ Requires-Dist: ruff; extra == "dev"
14
+ Dynamic: license-file
15
+
16
+ # awscreen
17
+
18
+ Find clickable elements by describing what they look like.
19
+
20
+ Part of the [Aither World (`aw*`)](https://github.com/Aitherium/awscreens) family of CLI tools.
21
+
22
+ ## Install
23
+
24
+ ```bash
25
+ pip install awscreen
26
+ ```
27
+
28
+ ## Usage
29
+
30
+ Find elements in a screenshot by natural language description:
31
+
32
+ ```bash
33
+ # Set your API key
34
+ export AWSCREEN_URL=http://localhost:8150 # a LOCAL vision model
35
+ export AWSCREEN_MODEL=your-vision-model
36
+
37
+ # Find the save button in a screenshot
38
+ awscreen screenshot.png "the blue save button in the top toolbar"
39
+ ```
40
+
41
+ Or use in Python:
42
+
43
+ ```python
44
+ from awscreen import Finder
45
+
46
+ finder = Finder() # reads AWSCREEN_URL / AWVISION_URL
47
+ screenshot = finder.load_image("screenshot.png")
48
+ results = finder.find(screenshot, "the blue save button")
49
+
50
+ for match in results:
51
+ print(f"Found at ({match.x}, {match.y}): {match.description}")
52
+ ```
53
+
54
+ ## How it works
55
+
56
+ `awscreen` analyzes screenshots using Claude's vision capabilities to find interactive elements matching your description. No pixel-perfect coordinates needed — just describe what you're looking for in natural language.
57
+
58
+ ### Features
59
+
60
+ - **Visual matching**: Describe elements like "the red button in the bottom right"
61
+ - **Confidence scores**: Each match includes a confidence rating
62
+ - **Bounding boxes**: Get precise pixel coordinates for click targets
63
+ - **Text output or JSON**: Choose human-readable or machine-parseable output
64
+
65
+ ## Exit codes
66
+
67
+ - `0`: Elements found; details printed
68
+ - `1`: No elements found matching the description
69
+ - `2`: Cannot proceed (missing API key, invalid image, API error)
70
+
71
+ ## API key
72
+
73
+ Requires an Anthropic API key for vision analysis. Provide it via:
74
+
75
+ 1. Environment variable: `AWSCREEN_URL` (falls back to `AWVISION_URL`)
76
+ 2. CLI argument: `awscreen image.png description --api-key sk-ant-...`
77
+
78
+ No API key. awscreen sends a picture of your screen, so it sends it to a
79
+ loopback endpoint you run -- nothing leaves the machine. It speaks the
80
+ OpenAI /v1/chat/completions shape, the same one awvision uses, so one
81
+ local vision model serves both.
82
+
83
+ ## Related
84
+
85
+ - `awiam` — identify who the caller is
86
+ - `awbac` — control what they may do
87
+ - `awseal` — prove it
88
+
89
+ ## License
90
+
91
+ Apache 2.0
@@ -0,0 +1,76 @@
1
+ # awscreen
2
+
3
+ Find clickable elements by describing what they look like.
4
+
5
+ Part of the [Aither World (`aw*`)](https://github.com/Aitherium/awscreens) family of CLI tools.
6
+
7
+ ## Install
8
+
9
+ ```bash
10
+ pip install awscreen
11
+ ```
12
+
13
+ ## Usage
14
+
15
+ Find elements in a screenshot by natural language description:
16
+
17
+ ```bash
18
+ # Set your API key
19
+ export AWSCREEN_URL=http://localhost:8150 # a LOCAL vision model
20
+ export AWSCREEN_MODEL=your-vision-model
21
+
22
+ # Find the save button in a screenshot
23
+ awscreen screenshot.png "the blue save button in the top toolbar"
24
+ ```
25
+
26
+ Or use in Python:
27
+
28
+ ```python
29
+ from awscreen import Finder
30
+
31
+ finder = Finder() # reads AWSCREEN_URL / AWVISION_URL
32
+ screenshot = finder.load_image("screenshot.png")
33
+ results = finder.find(screenshot, "the blue save button")
34
+
35
+ for match in results:
36
+ print(f"Found at ({match.x}, {match.y}): {match.description}")
37
+ ```
38
+
39
+ ## How it works
40
+
41
+ `awscreen` analyzes screenshots using Claude's vision capabilities to find interactive elements matching your description. No pixel-perfect coordinates needed — just describe what you're looking for in natural language.
42
+
43
+ ### Features
44
+
45
+ - **Visual matching**: Describe elements like "the red button in the bottom right"
46
+ - **Confidence scores**: Each match includes a confidence rating
47
+ - **Bounding boxes**: Get precise pixel coordinates for click targets
48
+ - **Text output or JSON**: Choose human-readable or machine-parseable output
49
+
50
+ ## Exit codes
51
+
52
+ - `0`: Elements found; details printed
53
+ - `1`: No elements found matching the description
54
+ - `2`: Cannot proceed (missing API key, invalid image, API error)
55
+
56
+ ## API key
57
+
58
+ Requires an Anthropic API key for vision analysis. Provide it via:
59
+
60
+ 1. Environment variable: `AWSCREEN_URL` (falls back to `AWVISION_URL`)
61
+ 2. CLI argument: `awscreen image.png description --api-key sk-ant-...`
62
+
63
+ No API key. awscreen sends a picture of your screen, so it sends it to a
64
+ loopback endpoint you run -- nothing leaves the machine. It speaks the
65
+ OpenAI /v1/chat/completions shape, the same one awvision uses, so one
66
+ local vision model serves both.
67
+
68
+ ## Related
69
+
70
+ - `awiam` — identify who the caller is
71
+ - `awbac` — control what they may do
72
+ - `awseal` — prove it
73
+
74
+ ## License
75
+
76
+ Apache 2.0
@@ -0,0 +1,5 @@
1
+ """awscreen: Find elements on screen by describing what they look like."""
2
+ from .finder import Element, Finder, Screenshot
3
+
4
+ __version__ = "1.0.0"
5
+ __all__ = ["Element", "Finder", "Screenshot"]
@@ -0,0 +1,118 @@
1
+ """Stack-aware `doctor` for awscreen.
2
+
3
+ GENERATED BY gen_aw_doctor.py -- DO NOT EDIT.
4
+ Regenerate it with the generator named above; a hand-edit here is reverted by
5
+ the next run and fails the parity gate.
6
+
7
+ Why a doctor exists at all: the aw* bricks are designed to COMPOSE, so the
8
+ interesting failures live BETWEEN them. "awscreen is installed" is not the useful
9
+ fact -- "awscreen is installed and the thing it pairs with is not" is. This reports
10
+ the whole stack, not just itself.
11
+
12
+ stdlib only, on purpose: a diagnostic that cannot run because a dependency is
13
+ missing is worthless precisely when you need it.
14
+ """
15
+ from __future__ import annotations
16
+
17
+ import importlib.util
18
+ import shutil
19
+ import sys
20
+
21
+ #: Frozen from AitherOS/config/ecosystem.yaml at generation time. A shipped
22
+ #: package cannot read the registry, and a doctor that guessed at the family
23
+ #: would go stale in silence. Regenerate to update.
24
+ SELF = 'awscreen'
25
+ FAMILY = ['awarena', 'awask', 'awbac', 'awbrowse', 'awdit', 'awevolve', 'awfind', 'awgit',
26
+ 'awgraph', 'awiam', 'awkno', 'awm', 'awmail', 'awnboard', 'awnest', 'awnet',
27
+ 'awprism', 'awreason', 'awrecover', 'awrecurse', 'awrelay', 'awrepl', 'awresearch',
28
+ 'awrise', 'awrun', 'awseal', 'awshare', 'awtoll', 'awtunnel', 'awvision',
29
+ 'awvoice', 'awwall']
30
+ PAIRS_WITH = ['awbrowse', 'awvision']
31
+
32
+
33
+ def _installed(mod: str) -> "str | None":
34
+ """Version if importable, else None. Never raises -- a broken sibling must
35
+ not take the diagnostic down with it."""
36
+ try:
37
+ if importlib.util.find_spec(mod) is None:
38
+ return None
39
+ except (ImportError, ValueError):
40
+ return None
41
+ try:
42
+ from importlib.metadata import PackageNotFoundError, version
43
+ try:
44
+ return version(mod)
45
+ except PackageNotFoundError:
46
+ return "installed"
47
+ except Exception:
48
+ return "installed"
49
+
50
+
51
+ def report(out=None) -> int:
52
+ """Print the stack picture. 0 = this brick and its pairs are present."""
53
+ out = out or sys.stdout
54
+ print(f"{SELF} doctor", file=out)
55
+
56
+ mine = _installed(SELF)
57
+ print(f" self {SELF} {mine or 'NOT IMPORTABLE'}", file=out)
58
+ shim = shutil.which(SELF)
59
+ print(f" command {shim or 'not on PATH'}", file=out)
60
+
61
+ # The stack. Siblings this brick pairs with are called out separately,
62
+ # because a missing pair is a REASON, while a missing unrelated brick is
63
+ # just a fact about your machine.
64
+ missing_pairs, present = [], []
65
+ for name in FAMILY:
66
+ v = _installed(name)
67
+ if v:
68
+ present.append(name)
69
+ elif name in PAIRS_WITH:
70
+ missing_pairs.append(name)
71
+ print(f" stack {len(present)}/{len(FAMILY)} aw* packages installed",
72
+ file=out)
73
+ if present:
74
+ print(f" {' '.join(sorted(present))}", file=out)
75
+
76
+ local = _local_checks()
77
+ for line in local:
78
+ print(f" {line}", file=out)
79
+
80
+ if mine is None:
81
+ print(f"\nverdict: {SELF} itself is not importable. Reinstall it before "
82
+ f"anything else here means much.", file=out)
83
+ return 1
84
+ if missing_pairs:
85
+ print(f"\nverdict: {SELF} works, but pairs with "
86
+ f"{', '.join(sorted(missing_pairs))} which "
87
+ f"{'is' if len(missing_pairs) == 1 else 'are'} not installed. "
88
+ f"That is a capability you are missing, not an error.", file=out)
89
+ return 0
90
+ print(f"\nverdict: {SELF} and everything it pairs with are present.", file=out)
91
+ return 0
92
+
93
+
94
+ def _local_checks() -> "list[str]":
95
+ """Per-brick checks, if this package defines them.
96
+
97
+ Kept as a HOOK rather than generated guesses: the generator knows the family
98
+ from the registry, but it does not know what awscreen needs at runtime, and a
99
+ doctor that invented config requirements would be confidently wrong. A
100
+ package supplies `_doctor_local()` returning display lines; absent, the
101
+ stack picture above still stands on its own.
102
+ """
103
+ try:
104
+ mod = importlib.import_module(f"{SELF}.doctor_local")
105
+ except Exception:
106
+ return []
107
+ try:
108
+ return list(mod._doctor_local())
109
+ except Exception as exc: # noqa: BLE001
110
+ return [f"local checks raised {type(exc).__name__}: {exc}"]
111
+
112
+
113
+ def main(argv: "list[str] | None" = None) -> int:
114
+ return report()
115
+
116
+
117
+ if __name__ == "__main__":
118
+ raise SystemExit(main())