awvision 0.1.0__tar.gz

awvision-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

awvision-0.1.0/PKG-INFO

@@ -0,0 +1,170 @@
+Metadata-Version: 2.4
+Name: awvision
+Version: 0.1.0
+Summary: Ask questions about images using a vision-capable model
+Author: AitherOS
+License: MIT
+Keywords: vision,image,llm,openai
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Dynamic: license-file
+
+# awvision
+
+Ask questions about images using a vision-capable model.
+
+## What it does
+
+awvision is a lightweight client for vision-capable, OpenAI-compatible LLM services. Send an image and a question, get an answer.
+
+The contract: **Ask a question about an image and get an answer.**
+
+## Installation
+
+```bash
+pip install -e .
+```
+
+Or with dev dependencies:
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Usage
+
+### Ask a question about an image
+
+```bash
+awvision ask image.png "What is in this image?"
+```
+
+### Describe an image
+
+```bash
+awvision describe image.jpg
+```
+
+### Compare two images
+
+```bash
+awvision compare image1.png image2.png
+```
+
+## Configuration
+
+Set environment variables to customize the endpoint and model:
+
+```bash
+export AWVISION_URL=http://localhost:8150
+export AWVISION_MODEL=gpt-4-vision
+```
+
+Or pass them as options:
+
+```bash
+awvision --endpoint http://localhost:8150 --model gpt-4-vision ask image.png "What's this?"
+```
+
+## Self-test
+
+Run the self-tests to verify awvision is working correctly:
+
+```bash
+awvision --self-test
+```
+
+This will:
+- Test image loading and encoding
+- Verify media type detection
+- Check endpoint configuration
+- Validate error handling
+
+## Requirements
+
+- Python 3.10+
+- A vision-capable LLM service (e.g., OpenAI-compatible API)
+- The service must support the `image_url` content block format
+
+## How it works
+
+awvision:
+1. Loads the image file and encodes it as base64
+2. Wraps it in an OpenAI-compatible chat message with `image_url` format
+3. Sends it to the configured vision service
+4. Returns the model's response
+
+### Important: Empty response detection
+
+If a text-only model receives an image, it typically returns HTTP 200 with an empty response. awvision detects this and raises a clear error:
+
+```
+ERROR: Model 'gpt-4-vision' at http://localhost:8150 returned empty content.
+This indicates the model does not support vision or cannot process image_url content blocks.
+Verify that:
+  1. The model 'gpt-4-vision' is vision-capable
+  2. The endpoint supports the image_url format
+  3. The image was properly encoded as a data URL
+```
+
+This prevents silent failures where an empty response looks like a successful query.
+
+## API
+
+For programmatic use:
+
+```python
+from awvision import ask_vision, describe_image, compare_images
+
+# Ask a question
+answer = ask_vision("image.png", "What color is this?")
+print(answer)
+
+# Describe an image
+description = describe_image("image.jpg")
+print(description)
+
+# Compare two images
+comparison = compare_images("image1.png", "image2.png")
+print(comparison)
+```
+
+## Error handling
+
+awvision provides clear error messages for common issues:
+
+- **FileNotFoundError**: Image file not found
+- **IOError**: Image file is empty or unreadable
+- **RuntimeError**: Vision service is unavailable, model has no vision, or response is empty
+
+All error messages include guidance on what to check.
+
+## Testing
+
+Run the test suite:
+
+```bash
+pytest tests/ -v
+```
+
+## Supported image formats
+
+- PNG (image/png)
+- JPEG (image/jpeg)
+- GIF (image/gif)
+- WebP (image/webp)
+
+## License
+
+MIT

awvision-0.1.0/README.md

@@ -0,0 +1,148 @@
+# awvision
+
+Ask questions about images using a vision-capable model.
+
+## What it does
+
+awvision is a lightweight client for vision-capable, OpenAI-compatible LLM services. Send an image and a question, get an answer.
+
+The contract: **Ask a question about an image and get an answer.**
+
+## Installation
+
+```bash
+pip install -e .
+```
+
+Or with dev dependencies:
+
+```bash
+pip install -e ".[dev]"
+```
+
+## Usage
+
+### Ask a question about an image
+
+```bash
+awvision ask image.png "What is in this image?"
+```
+
+### Describe an image
+
+```bash
+awvision describe image.jpg
+```
+
+### Compare two images
+
+```bash
+awvision compare image1.png image2.png
+```
+
+## Configuration
+
+Set environment variables to customize the endpoint and model:
+
+```bash
+export AWVISION_URL=http://localhost:8150
+export AWVISION_MODEL=gpt-4-vision
+```
+
+Or pass them as options:
+
+```bash
+awvision --endpoint http://localhost:8150 --model gpt-4-vision ask image.png "What's this?"
+```
+
+## Self-test
+
+Run the self-tests to verify awvision is working correctly:
+
+```bash
+awvision --self-test
+```
+
+This will:
+- Test image loading and encoding
+- Verify media type detection
+- Check endpoint configuration
+- Validate error handling
+
+## Requirements
+
+- Python 3.10+
+- A vision-capable LLM service (e.g., OpenAI-compatible API)
+- The service must support the `image_url` content block format
+
+## How it works
+
+awvision:
+1. Loads the image file and encodes it as base64
+2. Wraps it in an OpenAI-compatible chat message with `image_url` format
+3. Sends it to the configured vision service
+4. Returns the model's response
+
+### Important: Empty response detection
+
+If a text-only model receives an image, it typically returns HTTP 200 with an empty response. awvision detects this and raises a clear error:
+
+```
+ERROR: Model 'gpt-4-vision' at http://localhost:8150 returned empty content.
+This indicates the model does not support vision or cannot process image_url content blocks.
+Verify that:
+  1. The model 'gpt-4-vision' is vision-capable
+  2. The endpoint supports the image_url format
+  3. The image was properly encoded as a data URL
+```
+
+This prevents silent failures where an empty response looks like a successful query.
+
+## API
+
+For programmatic use:
+
+```python
+from awvision import ask_vision, describe_image, compare_images
+
+# Ask a question
+answer = ask_vision("image.png", "What color is this?")
+print(answer)
+
+# Describe an image
+description = describe_image("image.jpg")
+print(description)
+
+# Compare two images
+comparison = compare_images("image1.png", "image2.png")
+print(comparison)
+```
+
+## Error handling
+
+awvision provides clear error messages for common issues:
+
+- **FileNotFoundError**: Image file not found
+- **IOError**: Image file is empty or unreadable
+- **RuntimeError**: Vision service is unavailable, model has no vision, or response is empty
+
+All error messages include guidance on what to check.
+
+## Testing
+
+Run the test suite:
+
+```bash
+pytest tests/ -v
+```
+
+## Supported image formats
+
+- PNG (image/png)
+- JPEG (image/jpeg)
+- GIF (image/gif)
+- WebP (image/webp)
+
+## License
+
+MIT

awvision-0.1.0/awvision/__init__.py

@@ -0,0 +1,55 @@
+"""awvision - Ask questions about images using a vision-capable model."""
+
+__version__ = "0.1.0"
+__all__ = ["ask_vision", "describe_image", "compare_images"]
+
+
+def ask_vision(image_path: str, question: str, endpoint=None, model=None):
+    """Ask a question about an image.
+
+    Args:
+        image_path: Path to the image file
+        question: Question to ask about the image
+        endpoint: Vision API endpoint (default: env AWVISION_URL or http://localhost:8150)
+        model: Model name (default: env AWVISION_MODEL or gpt-4-vision)
+
+    Returns:
+        The model's response
+
+    Raises:
+        FileNotFoundError: If image file not found
+        RuntimeError: If vision service unavailable or model lacks vision
+    """
+    from awvision.vision import get_vision_response
+    return get_vision_response(image_path, question, endpoint, model)
+
+
+def describe_image(image_path: str, endpoint=None, model=None):
+    """Describe an image.
+
+    Args:
+        image_path: Path to the image file
+        endpoint: Vision API endpoint
+        model: Model name
+
+    Returns:
+        Description of the image
+    """
+    from awvision.vision import get_vision_response
+    return get_vision_response(image_path, "Describe this image in detail.", endpoint, model)
+
+
+def compare_images(image_a: str, image_b: str, endpoint=None, model=None):
+    """Compare two images.
+
+    Args:
+        image_a: Path to first image
+        image_b: Path to second image
+        endpoint: Vision API endpoint
+        model: Model name
+
+    Returns:
+        Comparison of the two images
+    """
+    from awvision.vision import compare_vision_images
+    return compare_vision_images(image_a, image_b, endpoint, model)

awvision-0.1.0/awvision/_doctor.py

@@ -0,0 +1,118 @@
+"""Stack-aware `doctor` for awvision.
+
+GENERATED BY gen_aw_doctor.py -- DO NOT EDIT.
+Regenerate it with the generator named above; a hand-edit here is reverted by
+the next run and fails the parity gate.
+
+Why a doctor exists at all: the aw* bricks are designed to COMPOSE, so the
+interesting failures live BETWEEN them. "awvision is installed" is not the useful
+fact -- "awvision is installed and the thing it pairs with is not" is. This reports
+the whole stack, not just itself.
+
+stdlib only, on purpose: a diagnostic that cannot run because a dependency is
+missing is worthless precisely when you need it.
+"""
+from __future__ import annotations
+
+import importlib.util
+import shutil
+import sys
+
+#: Frozen from AitherOS/config/ecosystem.yaml at generation time. A shipped
+#: package cannot read the registry, and a doctor that guessed at the family
+#: would go stale in silence. Regenerate to update.
+SELF = 'awvision'
+FAMILY = ['awarena', 'awask', 'awbac', 'awbrowse', 'awdit', 'awevolve', 'awfind', 'awgit',
+ 'awgraph', 'awiam', 'awkno', 'awm', 'awmail', 'awnboard', 'awnest', 'awnet',
+ 'awprism', 'awreason', 'awrecover', 'awrecurse', 'awrelay', 'awrepl', 'awresearch',
+ 'awrise', 'awrun', 'awscreen', 'awseal', 'awshare', 'awtoll', 'awtunnel',
+ 'awvoice', 'awwall']
+PAIRS_WITH = ['awbrowse', 'awscreen']
+
+
+def _installed(mod: str) -> "str | None":
+    """Version if importable, else None. Never raises -- a broken sibling must
+    not take the diagnostic down with it."""
+    try:
+        if importlib.util.find_spec(mod) is None:
+            return None
+    except (ImportError, ValueError):
+        return None
+    try:
+        from importlib.metadata import PackageNotFoundError, version
+        try:
+            return version(mod)
+        except PackageNotFoundError:
+            return "installed"
+    except Exception:
+        return "installed"
+
+
+def report(out=None) -> int:
+    """Print the stack picture. 0 = this brick and its pairs are present."""
+    out = out or sys.stdout
+    print(f"{SELF} doctor", file=out)
+
+    mine = _installed(SELF)
+    print(f"  self       {SELF} {mine or 'NOT IMPORTABLE'}", file=out)
+    shim = shutil.which(SELF)
+    print(f"  command    {shim or 'not on PATH'}", file=out)
+
+    # The stack. Siblings this brick pairs with are called out separately,
+    # because a missing pair is a REASON, while a missing unrelated brick is
+    # just a fact about your machine.
+    missing_pairs, present = [], []
+    for name in FAMILY:
+        v = _installed(name)
+        if v:
+            present.append(name)
+        elif name in PAIRS_WITH:
+            missing_pairs.append(name)
+    print(f"  stack      {len(present)}/{len(FAMILY)} aw* packages installed",
+          file=out)
+    if present:
+        print(f"             {' '.join(sorted(present))}", file=out)
+
+    local = _local_checks()
+    for line in local:
+        print(f"  {line}", file=out)
+
+    if mine is None:
+        print(f"\nverdict: {SELF} itself is not importable. Reinstall it before "
+              f"anything else here means much.", file=out)
+        return 1
+    if missing_pairs:
+        print(f"\nverdict: {SELF} works, but pairs with "
+              f"{', '.join(sorted(missing_pairs))} which "
+              f"{'is' if len(missing_pairs) == 1 else 'are'} not installed. "
+              f"That is a capability you are missing, not an error.", file=out)
+        return 0
+    print(f"\nverdict: {SELF} and everything it pairs with are present.", file=out)
+    return 0
+
+
+def _local_checks() -> "list[str]":
+    """Per-brick checks, if this package defines them.
+
+    Kept as a HOOK rather than generated guesses: the generator knows the family
+    from the registry, but it does not know what awvision needs at runtime, and a
+    doctor that invented config requirements would be confidently wrong. A
+    package supplies `_doctor_local()` returning display lines; absent, the
+    stack picture above still stands on its own.
+    """
+    try:
+        mod = importlib.import_module(f"{SELF}.doctor_local")
+    except Exception:
+        return []
+    try:
+        return list(mod._doctor_local())
+    except Exception as exc:                       # noqa: BLE001
+        return [f"local     checks raised {type(exc).__name__}: {exc}"]
+
+
+def main(argv: "list[str] | None" = None) -> int:
+    return report()
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())