lingo-ai 0.1.2__tar.gz

lingo_ai-0.1.2/.github/workflows/release.yaml

@@ -0,0 +1,56 @@
+name: Release Pipeline
+
+on:
+  release:
+    types: [created]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+
+      - name: Install dependencies
+        run: uv sync --all-extras --all-groups --no-editable
+
+      - name: Run format check
+        run: uv run black --check .
+
+      - name: Run tests with coverage
+        run: uv run pytest --cov=beaver --cov-report=xml --cov-report=term
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v4
+        with:
+          files: ./coverage.xml
+          fail_ci_if_error: false
+
+  publish-pypi:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish --token ${{ secrets.PYPI_TOKEN }}

lingo_ai-0.1.2/.github/workflows/tests.yaml

@@ -0,0 +1,32 @@
+name: Run Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install uv
+        run: curl -LsSf https://astral.sh/uv/install.sh | sh
+
+      - name: Install dependencies
+        run: uv sync --all-extras --all-groups --no-editable
+
+      - name: Run format check
+        run: uv run black --check .
+
+      - name: Run tests with coverage
+        run: uv run pytest --cov=beaver --cov-report=xml --cov-report=term

lingo_ai-0.1.2/.gitignore

@@ -0,0 +1,217 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

lingo_ai-0.1.2/.python-version

@@ -0,0 +1 @@
+3.12

lingo_ai-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Grupo de Inteligencia Artificial (GIA-UH)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

lingo_ai-0.1.2/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: lingo-ai
+Version: 0.1.2
+Summary: Add your description here
+Author-email: Alejandro Piad <apiad@apiad.net>
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: openai>=2.7.2
+Requires-Dist: pydantic>=2.12.4
+Description-Content-Type: text/markdown
+
+<p align="center"> <img src="https://github.com/user-attachments/assets/27a24307-cda0-4fa8-ba6c-9b5ca9b27efe" alt="lingo library logo" width="300"/> </p>
+
+<p align="center"> <strong>A minimal, async-native, and unopinionated toolkit for modern LLM applications.</strong> </p>
+
+---
+
+<!-- Project badges -->
+![PyPI - Version](https://img.shields.io/pypi/v/lingo)
+![PyPi - Python Version](https://img.shields.io/pypi/pyversions/lingo)
+![Github - Open Issues](https://img.shields.io/github/issues-raw/gia-uh/lingo)
+![PyPi - Downloads (Monthly)](https://img.shields.io/pypi/dm/lingo)
+![Github - Commits](https://img.shields.io/github/commit-activity/m/gia-uh/lingo)
+
+-----
+
+`lingo` provides a powerful, two-layered API for building, testing, and deploying complex LLM workflows with precision and clarity.
+
+## The Philosophy: A Dual-Layer API
+
+`lingo` is built on the idea that developers need both a high-level, declarative way to _build_ workflows and a low-level, imperative way to _control_ them.
+
+1. **The High-Level `Flow` API**: For most applications, you'll use the fluent, chainable `Flow` API. This allows you to define complex, reusable conversation logic with branching, tool use, and subroutines in a declarative, readable way.
+
+2. **The Low-Level `Context` API**: For full, fine-grained control, `lingo` provides the `LLM` and `Context` classes. This imperative layer is perfect for building custom chatbot loops or implementing your own conversational state logic from scratch.
+
+
+## Installation
+
+```
+pip install lingo
+```
+
+_(Note: `lingo` is not yet on PyPI. This is the intended installation method.)_
+
+## Quickstart: Building a Declarative `Flow`
+
+Let's build a simple assistant that can check the weather, but will first decide if the user is being polite.
+
+### 1. Define Tools & LLM
+
+```python
+import asyncio
+from lingo.llm import LLM, Message
+from lingo.tools import tool
+from lingo.flow import Flow, NoOp
+
+llm = LLM(model="gpt-4o")
+
+@tool
+async def get_weather(location: str) -> str:
+    """Gets the current weather for a specified location."""
+    if "boston" in location.lower():
+        return "It's 75°F and sunny in Boston."
+    else:
+        return f"Weather for {location} is unknown."
+```
+
+### 2. Define Reusable Sub-Flows
+
+
+```python
+# A sub-flow is just another 'Flow' instance.
+polite_flow = Flow().system(
+    "Acknowledge the user's politeness before proceeding."
+)
+```
+
+### 3. Define the Main Workflow
+
+
+```python
+main_flow = (
+    Flow()
+    # Step 1: Add a system message to the context
+    .system("You are a helpful assistant. You can check the weather.")
+
+    # Step 2: Use an LLM to make a True/False decision
+    .decide(
+        prompt="Is the user being polite (e.g., asking 'please')?",
+        on_true=polite_flow,  # Run the sub-flow if True
+        on_false=NoOp()       # Do nothing if False
+    )
+
+    # Step 3: Equip and invoke a tool from the available list
+    .invoke(get_weather)
+
+    # Step 4: Generate a final reply using the tool's output
+    .reply()
+)
+```
+
+### 4. Execute the Flow
+
+
+```python
+async def main():
+    # Example 1: The "polite" branch
+    user_query_1 = "Could you please tell me the weather in Boston?"
+
+    # .execute() runs the full pipeline on the initial messages
+    final_context = await main_flow.run(llm, [Message.user(user_query_1)])
+
+    print(f"User: {user_query_1}")
+    print(f"Assistant: {final_context.messages[-1].content}")
+    # Assistant: It's 75°F and sunny in Boston. I'm happy to help!
+
+    print("\n" + "-"*20 + "\n")
+
+    # Example 2: The "impolite" branch
+    user_query_2 = "boston weather now"
+    final_context_2 = await main_flow.run(llm, [Message.user(user_query_2)])
+
+    print(f"User: {user_query_2}")
+    print(f"Assistant: {final_context_2.messages[-1].content}")
+    # Assistant: It's 75°F and sunny in Boston.
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## The Two APIs
+
+`lingo` gives you the flexibility to choose the right level of abstraction.
+
+### 1. High-Level API: `Flow`
+
+The `Flow` class provides a fluent, chainable interface for declaratively building reusable workflows. You define the _steps_ of the conversation, and `lingo` handles the execution.
+
+```python
+# A flow is a composable, reusable blueprint
+weather_flow = (
+    Flow()
+    .system("You only answer with the weather.")
+    .invoke(get_weather)
+    .reply()
+)
+
+# You can nest flows inside other flows
+main_flow = (
+    Flow()
+    .choose(
+        prompt="Is the user asking about weather or stocks?",
+        choices={
+            "weather": weather_flow,
+            "stocks": stock_flow,
+        }
+    )
+)
+```
+
+### 2. Low-Level API: `LLM` & `Context`
+
+For maximum control, you can use the imperative API. The `Context` object holds the message history, and you call its methods (`.reply()`, `.decide()`, `.invoke()`) directly. This is ideal for building custom chatbot loops.
+
+```python
+# Manually building a conversation turn by turn
+llm = LLM(model="gpt-4o")
+context = Context(llm, [Message.system("You are a chatbot.")])
+
+while True:
+    user_input = input("You: ")
+    context.add(Message.user(user_input))
+
+    # Call the LLM with the current context
+    response = await context.reply()
+
+    context.add(response)
+    print(f"Bot: {response.content}")
+```
+
+## Contributing
+
+Contributions are welcome! `lingo` is an open-source project, and we'd love your help in making it better. Please feel free to open an issue or submit a pull request.
+
+## License
+
+`lingo` is licensed under the **MIT License**. See the `LICENSE` file for details.

lingo_ai-0.1.2/README.md

@@ -0,0 +1,177 @@
+<p align="center"> <img src="https://github.com/user-attachments/assets/27a24307-cda0-4fa8-ba6c-9b5ca9b27efe" alt="lingo library logo" width="300"/> </p>
+
+<p align="center"> <strong>A minimal, async-native, and unopinionated toolkit for modern LLM applications.</strong> </p>
+
+---
+
+<!-- Project badges -->
+![PyPI - Version](https://img.shields.io/pypi/v/lingo)
+![PyPi - Python Version](https://img.shields.io/pypi/pyversions/lingo)
+![Github - Open Issues](https://img.shields.io/github/issues-raw/gia-uh/lingo)
+![PyPi - Downloads (Monthly)](https://img.shields.io/pypi/dm/lingo)
+![Github - Commits](https://img.shields.io/github/commit-activity/m/gia-uh/lingo)
+
+-----
+
+`lingo` provides a powerful, two-layered API for building, testing, and deploying complex LLM workflows with precision and clarity.
+
+## The Philosophy: A Dual-Layer API
+
+`lingo` is built on the idea that developers need both a high-level, declarative way to _build_ workflows and a low-level, imperative way to _control_ them.
+
+1. **The High-Level `Flow` API**: For most applications, you'll use the fluent, chainable `Flow` API. This allows you to define complex, reusable conversation logic with branching, tool use, and subroutines in a declarative, readable way.
+
+2. **The Low-Level `Context` API**: For full, fine-grained control, `lingo` provides the `LLM` and `Context` classes. This imperative layer is perfect for building custom chatbot loops or implementing your own conversational state logic from scratch.
+
+
+## Installation
+
+```
+pip install lingo
+```
+
+_(Note: `lingo` is not yet on PyPI. This is the intended installation method.)_
+
+## Quickstart: Building a Declarative `Flow`
+
+Let's build a simple assistant that can check the weather, but will first decide if the user is being polite.
+
+### 1. Define Tools & LLM
+
+```python
+import asyncio
+from lingo.llm import LLM, Message
+from lingo.tools import tool
+from lingo.flow import Flow, NoOp
+
+llm = LLM(model="gpt-4o")
+
+@tool
+async def get_weather(location: str) -> str:
+    """Gets the current weather for a specified location."""
+    if "boston" in location.lower():
+        return "It's 75°F and sunny in Boston."
+    else:
+        return f"Weather for {location} is unknown."
+```
+
+### 2. Define Reusable Sub-Flows
+
+
+```python
+# A sub-flow is just another 'Flow' instance.
+polite_flow = Flow().system(
+    "Acknowledge the user's politeness before proceeding."
+)
+```
+
+### 3. Define the Main Workflow
+
+
+```python
+main_flow = (
+    Flow()
+    # Step 1: Add a system message to the context
+    .system("You are a helpful assistant. You can check the weather.")
+
+    # Step 2: Use an LLM to make a True/False decision
+    .decide(
+        prompt="Is the user being polite (e.g., asking 'please')?",
+        on_true=polite_flow,  # Run the sub-flow if True
+        on_false=NoOp()       # Do nothing if False
+    )
+
+    # Step 3: Equip and invoke a tool from the available list
+    .invoke(get_weather)
+
+    # Step 4: Generate a final reply using the tool's output
+    .reply()
+)
+```
+
+### 4. Execute the Flow
+
+
+```python
+async def main():
+    # Example 1: The "polite" branch
+    user_query_1 = "Could you please tell me the weather in Boston?"
+
+    # .execute() runs the full pipeline on the initial messages
+    final_context = await main_flow.run(llm, [Message.user(user_query_1)])
+
+    print(f"User: {user_query_1}")
+    print(f"Assistant: {final_context.messages[-1].content}")
+    # Assistant: It's 75°F and sunny in Boston. I'm happy to help!
+
+    print("\n" + "-"*20 + "\n")
+
+    # Example 2: The "impolite" branch
+    user_query_2 = "boston weather now"
+    final_context_2 = await main_flow.run(llm, [Message.user(user_query_2)])
+
+    print(f"User: {user_query_2}")
+    print(f"Assistant: {final_context_2.messages[-1].content}")
+    # Assistant: It's 75°F and sunny in Boston.
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## The Two APIs
+
+`lingo` gives you the flexibility to choose the right level of abstraction.
+
+### 1. High-Level API: `Flow`
+
+The `Flow` class provides a fluent, chainable interface for declaratively building reusable workflows. You define the _steps_ of the conversation, and `lingo` handles the execution.
+
+```python
+# A flow is a composable, reusable blueprint
+weather_flow = (
+    Flow()
+    .system("You only answer with the weather.")
+    .invoke(get_weather)
+    .reply()
+)
+
+# You can nest flows inside other flows
+main_flow = (
+    Flow()
+    .choose(
+        prompt="Is the user asking about weather or stocks?",
+        choices={
+            "weather": weather_flow,
+            "stocks": stock_flow,
+        }
+    )
+)
+```
+
+### 2. Low-Level API: `LLM` & `Context`
+
+For maximum control, you can use the imperative API. The `Context` object holds the message history, and you call its methods (`.reply()`, `.decide()`, `.invoke()`) directly. This is ideal for building custom chatbot loops.
+
+```python
+# Manually building a conversation turn by turn
+llm = LLM(model="gpt-4o")
+context = Context(llm, [Message.system("You are a chatbot.")])
+
+while True:
+    user_input = input("You: ")
+    context.add(Message.user(user_input))
+
+    # Call the LLM with the current context
+    response = await context.reply()
+
+    context.add(response)
+    print(f"Bot: {response.content}")
+```
+
+## Contributing
+
+Contributions are welcome! `lingo` is an open-source project, and we'd love your help in making it better. Please feel free to open an issue or submit a pull request.
+
+## License
+
+`lingo` is licensed under the **MIT License**. See the `LICENSE` file for details.