Metadata-Version: 2.4
Name: zyx
Version: 1.0.26
Summary: ZYX
Author-email: Hammad Saeed <hvmmad@gmail.com>
License:                                  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.
License-File: LICENSE
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Python: >=3.11
Requires-Dist: markitdown>=0.1.4
Requires-Dist: openai>=2.16.0
Requires-Dist: pydantic-ai-slim>=1.58.0
Requires-Dist: pydantic-monty>=0.0.4
Requires-Dist: toonify>=1.6.0
Provides-Extra: ai
Requires-Dist: pydantic-ai; extra == 'ai'
Provides-Extra: chroma
Requires-Dist: chromadb; extra == 'chroma'
Provides-Extra: examples
Requires-Dist: marimo; extra == 'examples'
Provides-Extra: qdrant
Requires-Dist: qdrant-client[fastembed]; extra == 'qdrant'
Description-Content-Type: text/markdown

# zyx

[![PyPI version](https://img.shields.io/pypi/v/zyx.svg)](https://pypi.org/project/zyx/)
[![Python version](https://img.shields.io/pypi/pyversions/zyx.svg?cacheSeconds=3600)](https://pypi.org/project/zyx/)
[![License](https://img.shields.io/github/license/hsaeed3/zyx.svg)](https://github.com/hsaeed3/zyx/blob/main/LICENSE)

![ZYX](./docs/assets/zyx-dark.png)

> A fun **"anti-framework"** for doing useful things with agents and LLMs.

---

**Documentation**: [https://zyx.hammad.app](https://zyx.hammad.app)

---

`ZYX` is a simplicity-first library wrapped on top of [Pydantic AI](https://ai.pydantic.dev/) and heavily inspired by [Marvin](https://askmarvin.ai/). It aims to provide a simple, *stdlib-like* interface for working with language models, without loss of control or flexibility that more complex frameworks provide.

## Key Features

* **Simplicity-First**: Designed to be as simple as possible to use. The library uses semantically literal function names—a 12-year-old could pick it up and run with it immediately.
* **Fast & Flexible**: Optimized for both performance and development speed, providing a flexible interface that enables rapid prototyping and iteration.
* **Type-Focused**: Leverages [Pydantic](https://docs.pydantic.dev/)'s powerful validation capabilities to ensure your data is always in the expected format, with full type safety and editor support.
* **Model Agnostic**: Through [Pydantic AI](https://ai.pydantic.dev/), `ZYX` supports virtually *any* LLM provider—OpenAI, Anthropic, Google, and more.
* **Semantic Operations**: A clean set of operations (`make`, `parse`, `query`, `edit`, `select`, `validate`) that cover common LLM use cases.
* **Resource Management**: Built-in support for files, code, and vector memory as first-class resources.
* **Streaming Support**: Built-in streaming for real-time responses and partial results.

## Requirements

`ZYX` stands on the shoulders of giants:

* [Pydantic AI](https://ai.pydantic.dev/) for LLM integration
* [Pydantic](https://docs.pydantic.dev/) for data validation
* [MarkItDown](https://github.com/microsoft/markitdown) used by `Attachments` for rendering to text
* Python 3.11+

## Installation

Install `ZYX` using pip:

```bash
pip install zyx
```

By default, `ZYX` installs the minimum required dependencies from [Pydantic AI](https://ai.pydantic.dev/) using their `pydantic-ai-slim` package, along with the `openai` library for out-of-the-box OpenAI support.

### Additional Providers

To add support for additional LLM providers, you can either install the entire `pydantic-ai` package or add providers individually:

```bash
# Install all providers
pip install zyx pydantic-ai

# Or use the `ai` extra
pip install 'zyx[ai]'

# Or add providers manually
pip install zyx anthropic
```

## Quickstart

### Generate Content

The easiest way to use LLMs within `ZYX` is through **semantic operations**. Start with `zyx.make` to generate content:

```python
import zyx

result = zyx.make(
    target=int,
    context="What is 45+45?",
    model="openai:gpt-4o-mini",
)

print(result.output)
"""
90
"""
```

### Parse Structured Data

Use `zyx.parse` to extract structured data from any source:

```python
import zyx
from pydantic import BaseModel

class Information(BaseModel):
    library_name: str
    library_description: str

result = zyx.parse(
    source=zyx.paste("https://zyx.hammad.app"),
    target=Information,
    model="openai:gpt-4o-mini",
)

print(result.output.library_name)
print(result.output.library_description)
"""
ZYX
A fun "anti-framework" for doing useful things with agents and LLMs.
"""
```

### Query with Tools

Add tools to any semantic operation for enhanced capabilities. Notice how we mix a snippet, string, and OpenAI dict:

```python
import zyx
from pydantic import BaseModel

class Information(BaseModel):
    library_name: str
    library_description: str

def log_website_url(url: str) -> None:
    print(f"Website URL: {url}")

result = zyx.parse(
    source=zyx.paste("https://zyx.hammad.app"),
    target=Information,
    context=[
        {"role": "system", "content": "You are a web scraper."},
        zyx.paste("scraping_instructions.txt"),
        "log the website URL before you parse.",
    ],
    model="anthropic:claude-sonnet-4-5",
    tools=[log_website_url],
)

print(result.output.library_name)
print(result.output.library_description)
"""
Website URL: https://zyx.hammad.app
ZYX
A fun "anti-framework" for doing useful things with agents and LLMs.
"""
```

### Edit Values

Use `zyx.edit` to modify existing values:

```python
import zyx

data = {"name": "John", "age": 30}

result = zyx.edit(
    target=data,
    context="Update the age to 31",
    model="anthropic:claude-sonnet-4-5",
    merge=False
)

print(result.output)
"""
{"name": None, "age": 31}
"""
```

### Query Grounded Sources

Use `zyx.query` to ask questions about a source, that is grounded/anchored to a specific source's content.

```python
import zyx

result = zyx.query(
    source="Python is a high-level programming language...",
    target=str,
    context="What is Python?",
    model="openai:gpt-4o-mini",
)

print(result.output)
"""
Python is a high-level programming language.
"""
```

### Select from Options

Use `zyx.select` to choose from a list of options:

```python
import zyx
from typing import Literal

Color = Literal["red", "green", "blue"]

result = zyx.select(
    target=Color,
    context="What color is the sky?",
    model="openai:gpt-4o-mini",
)

print(result.output)
"""
blue
"""
```

### Async Support

All operations have async variants:

```python
import zyx

result = await zyx.amake(
    target=str,
    context="Write a haiku about Python",
    model="openai:gpt-4o-mini",
)

print(result.output)
"""
Code flows like a stream,  
Indents guide the logic's dance,  
Python dreams in light. 
"""
```

### Streaming

Get real-time results with streaming:

```python
import zyx

stream = zyx.make(
    target=str,
    context="Write a short story",
    model="openai:gpt-4o-mini",
    stream=True,
)

for text in stream.text():
    print(text, end="", flush=True)
"""
**The Last Library**

In a small town nestled between rolling...
"""
```

## Semantic Operations

`ZYX` provides a set of semantic operations that cover common LLM use cases:

* **`make`** / **`amake`**: Generate new content for a target type or value
* **`parse`** / **`aparse`**: Extract structured content from a primary source
* **`query`** / **`aquery`**: Answer questions grounded in the primary source
* **`edit`** / **`aedit`**: Modify a target value or object, optionally selective or planned
* **`select`** / **`aselect`**: Choose from a list/enum/literal set
* **`validate`** / **`avalidate`**: Parse then verify constraints; can return structured violations
* **`expr`**: Semantic expression helpers (`==`, `in`, `bool`) using `parse`

## Resources

`ZYX` provides first-class support for resources that models can read, query, or mutate:

* **`File`**: Filesystem files (text/JSON/YAML/TOML/etc.) with anchor-based edits
* **`Code`**: Code files with language-aware parsing and editing
* **`Memory`**: Vector-store-backed resource for add/search/delete operations

## Context Management

The `context` parameter in semantic operations accepts flexible input types that are automatically converted to messages. **You can mix and match any combination of context types however you want**—pass a single item or a list of items, and they'll be combined into a conversation history.

### String Context

Simple strings are treated as user messages:

```python
import zyx

result = zyx.make(target=str, context="What is Python?")
```

### Role-Tagged Strings

Use role tags to create multiple messages in a single string:

```python
import zyx

# Supported tags: [s]/[system], [u]/[user], [a]/[assistant]
context = """
[s]You are a helpful assistant.[/s]
[u]What is Python?[/u]
[a]Python is a programming language.[/a]
[u]Tell me more.[/u]
"""

result = zyx.make(target=str, context=context)
```

### Context Objects

Use `zyx.Context` to manage conversation history, instructions, and tools across operations:

```python
import zyx

ctx = zyx.create_context(
    instructions="You are a helpful assistant",
    auto_update=True,
)

# Pass context as a list item
result1 = zyx.make(target=str, context=[ctx, "What is Python?"])
result2 = zyx.make(target=str, context=[ctx, "Tell me more about that"])
```

### Attachments

Use `zyx.paste()` to include files, URLs, or other content as attachments:

```python
import zyx

# Include a file
result = zyx.parse(
    source=zyx.paste("data.json"),
    target=dict,
    context=[zyx.paste("schema.txt"), "Parse this according to the schema"],
)

# Include a URL
result = zyx.query(
    source=zyx.paste("https://example.com/article"),
    target=str,
    context="Summarize this article",
)

# Include raw bytes or objects
result = zyx.parse(
    source=zyx.paste(b"raw binary data"),
    target=str,
    context="What is this?",
)
```

Use `zyx.attach()` to include a Pythonic object as an attachment:

```python
import zyx

result = zyx.parse(
    target=str,
    attachments=[zyx.attach({"name": "John", "age": 30})],
    context="What is the name of the person?",
)
```

### Mix and Match Freely

**The real power is mixing everything together.** Combine strings, Context objects, snippets, OpenAI dicts, role-tagged strings, and more—however you want:

```python
import zyx
from pydantic_ai import ModelRequest

ctx = zyx.create_context(instructions="You are a data analyst")

# Wild combination example - mix everything!
result = zyx.parse(
    source=zyx.paste("data.csv"),
    target=dict,
    context=[
        # Start with a Context object
        ctx,
        # Add a role-tagged string
        "[s]Also consider the following guidelines.[/s]",
        # Include a file snippet
        zyx.paste("instructions.md"),
        # Add an OpenAI-style system message
        {"role": "system", "content": "Be thorough in your analysis."},
        # Mix in a direct PydanticAI message
        ModelRequest.user_text_prompt("Parse the CSV file according to all the instructions above"),
        # Add more snippets
        zyx.paste("reference_data.json"),
        # Another role-tagged message
        "[u]Focus on accuracy over speed.[/u]",
        # More OpenAI dicts
        {
            "role": "assistant",
            "content": "I understand. I'll parse the data carefully."
        },
        # Final instruction as plain string
        "Now proceed with the parsing.",
    ],
)

# Another example: building context dynamically
messages = [
    {"role": "system", "content": "You are a code reviewer."},
    zyx.paste("code.py"),
    "[s]Review this code for security issues.[/s]",
    zyx.paste("security_guidelines.md"),
    "Provide detailed feedback.",
]

result = zyx.query(
    source=zyx.paste("code.py"),
    target=str,
    context=messages,
)
```

### Pydantic Models

Pydantic models are automatically converted to dictionaries:

```python
import zyx
from pydantic import BaseModel

class Message(BaseModel):
    role: str
    content: str

msg = Message(role="user", content="Hello!")

result = zyx.make(target=str, context=[msg])
```

## Type Safety

`ZYX` leverages Python's type system and Pydantic for full type safety:

```python
import zyx
from pydantic import BaseModel

class User(BaseModel):
    name: str
    age: int

result = zyx.parse(
    source='{"name": "Alice", "age": 30}',
    target=User,
    model="openai:gpt-4o-mini",
)

# result.output is fully typed as User
print(result.output.name)  # Type-checked!
print(result.output.age)   # Type-checked!
```

## Documentation

For more detailed documentation, examples, and guides, visit:

**[https://zyx.hammad.app](https://zyx.hammad.app)**

## License

This project is licensed under the terms of the MIT license.
