aixtools 0.1.0__tar.gz → 0.1.1__tar.gz

aixtools-0.1.1/.env_template

@@ -0,0 +1,42 @@
+#-----------------------------------------------------------------------------
+#
+# Template for .env file
+#
+#-----------------------------------------------------------------------------
+
+
+MODEL_FAMILY=azure
+VDB_EMBEDDINGS_MODEL_FAMILY=azure
+
+MODEL_TIMEOUT=120
+
+# Azure OpenAI
+AZURE_OPENAI_ENDPOINT=https://your_endpoint.openai.azure.com
+AZURE_OPENAI_API_VERSION=2024-06-01
+AZURE_OPENAI_API_KEY=your_secret_key
+AZURE_MODEL_NAME=gpt-4o
+AZURE_OPENAI_PROVIDER_ID=azure
+AZURE_VDB_EMBEDDINGS_MODEL_NAME=text-embedding-3-small
+
+
+# Open AI
+OPENAI_MODEL_NAME=gpt-4.5-preview
+OPENAI_API_KEY=openai_api_key
+OPENAI_VDB_EMBEDDINGS_MODEL_NAME=text-embedding-3-small
+
+# Ollama models
+OLLAMA_MODEL_NAME=llama3.2:3b-instruct-fp16
+OLLAMA_LOCAL_URL=http://localhost:11434/v1
+OLLAMA_VDB_EMBEDDINGS_MODEL_NAME=snowflake-arctic-embed2:latest
+
+# Docker and CI/CD Configuration (optional)
+# These variables are used for Docker builds and GitHub workflows
+DOCKER_WORKFLOW_REPO=your-org/your-reusable-workflows
+DOCKER_REPO_NAME=your-docker-repo
+DOCKER_REPO_PATH=your-path
+DOCKER_REGISTRY=your-registry.com:443
+DOCKER_ARTIFACTORY_USERNAME=your_username
+# DOCKER_ARTIFACTORY_API_KEY should be set as a GitHub secret
+
+# Custom certificate for Docker builds (optional)
+# CUSTOM_CERT_FILE=/path/to/your/certificate.crt

aixtools-0.1.1/.github/workflows/build_and_publish_docker.yml

@@ -0,0 +1,34 @@
+name: Build and Publish
+
+on:
+  push:
+    branches: [main]
+
+jobs:
+  build-and-publish-docker-images:
+    runs-on: ubuntu-latest
+    steps:
+      - name: build and publish
+        uses: ${{ vars.DOCKER_WORKFLOW_REPO }}/.github/workflows/publish_docker_artifactory.yml@main
+        with:
+          REPO_NAME: ${{ vars.DOCKER_REPO_NAME }}
+          REPO_PATH: ${{ vars.DOCKER_REPO_PATH }}
+          IMAGE_NAME: mcp-base
+          DOCKER_TAG: ${{ github.sha }}
+          CONTEXT: docker/mcp-base
+        # secrets:
+          DOS_ARTIFACTORY_USERNAME: ${{ vars.DOCKER_ARTIFACTORY_USERNAME }}
+          DOS_ARTIFACTORY_API_KEY: ${{ secrets.DOCKER_ARTIFACTORY_API_KEY }}
+      - name: test docker interaction
+        run: |
+          echo "Testing Docker interaction..."
+          docker --version
+          docker images
+          docker rm ${{ vars.DOCKER_REGISTRY }}/${{ vars.DOCKER_REPO_PATH }}/mcp-base:${{ github.sha }} || true
+          docker images
+          docker pull ${{ vars.DOCKER_REGISTRY }}/${{ vars.DOCKER_REPO_PATH }}/mcp-base:${{ github.sha }} || true
+          docker images
+          echo "Docker interaction test completed."
+        env:
+          DOCKER_BUILDKIT: 1
+          DOCKER_CLI_EXPERIMENTAL: enabled

aixtools-0.1.1/.github/workflows/lint.yml

@@ -0,0 +1,37 @@
+name: Lint and Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python 3.12
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+
+      - name: Install uv
+        run: |
+          pip install uv
+
+      - name: Install dependencies
+        run: |
+          uv sync
+          uv pip install -e ".[feature]"
+
+      - name: Set up environment
+        run: |
+          touch .env
+
+      - name: Run linting
+        run: |
+          ./scripts/lint.sh

aixtools-0.1.1/.github/workflows/release.yml

@@ -0,0 +1,37 @@
+name: Release
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch: # Temporarily allow manual triggering
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    environment: release
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0 # Fetch full history for setuptools_scm
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Install build dependencies
+        run: uv sync --group dev
+
+      - name: Build package
+        run: uv run python -m build
+
+      - name: Check package contents
+        run: |
+          ls -la dist/
+          uv run python -m twine check dist/*
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          skip-existing: true

aixtools-0.1.1/.gitignore

@@ -0,0 +1,188 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+.DS_Store
+agents/.DS_Store
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# 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
+.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/
+
+#IDEs
+.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Chainlit stuff
+.files/
+
+# Data directories
+data/
+aixtools/data/
+logs/
+aixtools/_version.py

aixtools-0.1.1/.python-version

@@ -0,0 +1 @@
+3.12.2

aixtools-0.1.1/.roo/rules/rules-mcp.md

@@ -0,0 +1,170 @@
+# FastMCP Server Guidelines
+
+These are the core conventions and patterns you should follow when building Python MCP servers with FastMCP.
+
+---
+
+## 1. Server Initialization  
+
+References: [FastMCP Servers docs](https://gofastmcp.com/servers/fastmcp#initialization), [GitHub examples](https://github.com/jlowin/fastmcp/blob/main/examples/readme-quickstart.py)
+
+```python
+from fastmcp import FastMCP
+
+mcp = FastMCP(
+    name="MyServer",                  # Optional (recommended): human-readable identifier
+    instructions="Describe usage...", # Optional (recommended): high‑level guidance for clients
+    lifespan=startup_shutdown_mgr,    # optional async context manager
+    tags={"analytics", "beta"}        # optional server tags
+)
+```
+
+---
+
+## 2. Core Components
+
+References: [FastMCP Servers docs](https://gofastmcp.com/servers/fastmcp#components), [GitHub examples](https://github.com/jlowin/fastmcp/blob/main/examples/readme-quickstart.py)
+
+1. **Tools**: functions clients invoke
+
+```python
+@mcp.tool()
+def multiply(a: float, b: float) -> float:
+    """Multiply two numbers."""
+    return a * b
+```
+2. **Resources**: read‑only data endpoints
+
+```python
+@mcp.resource("config://settings")
+def get_settings() -> dict:
+    return {"mode": "prod"}
+```
+3. **Resource Templates**: parameterized URIs
+
+```python
+@mcp.resource("users://{user_id}/profile")
+def user_profile(user_id: int) -> dict:
+    return {"id": user_id}
+```
+4. **Prompts**: reusable LLM message builders
+
+```python
+@mcp.prompt()
+def summarize(text: str) -> str:
+    return f"Summarize:\n\n{text}"
+```
+
+---
+
+## 3. Running & Transport
+
+References: [FastMCP Servers docs](https://gofastmcp.com/servers/fastmcp#running), [GitHub examples](https://github.com/jlowin/fastmcp/blob/main/examples/streaming.py)
+
+```python
+if __name__ == "__main__":
+    # STDIO (We use this for mostly for easy debugging)
+    # mcp.run()
+
+    # Streamable HTTP
+    mcp.run(transport="streamable-http", host="127.0.0.1", port=9000)
+```
+
+---
+
+## 4. Error Handling
+
+References: [FastMCP Servers docs](https://gofastmcp.com/servers/fastmcp#error-handling)
+
+* **Catch and wrap** exceptions within tools; raise clear, user‑friendly errors instead of raw tracebacks.
+* **Log failures** (timeouts, validation, security) at WARN/ERROR level for diagnostics.
+* **Handle external calls** safely:
+
+```python
+@mcp.tool()
+def fetch_data(url: str) -> dict:
+    try:
+        return httpx.get(url, timeout=5.0).json()
+    except httpx.TimeoutException:
+        raise RuntimeError("Upstream timed out—please try again later.")
+    except Exception as e:
+        mcp.log.error("fetch_data failed", exc_info=e)
+        raise
+```
+* **Structured error payloads**: FastMCP marks `isError=true` and includes your message rather than crashing.
+
+---
+
+## 5. Composing & Mounting
+
+References: [FastMCP Servers docs](https://gofastmcp.com/servers/fastmcp#composition), [GitHub examples](https://github.com/jlowin/fastmcp/blob/main/examples/mount_example.py)
+
+You can split large apps into modular servers and link them:
+
+```python
+from fastmcp import FastMCP
+
+main = FastMCP(name="Main")
+sub  = FastMCP(name="Sub")
+
+@sub.tool()
+def hello() -> str:
+    return "hi"
+
+# Live mount: updates in `sub` appear immediately in `main`
+main.mount("sub", sub)
+
+# Static import: snapshot of `sub` is copied into `main`
+main.import_server("sub", sub)
+```
+
+---
+
+## 6. Returning Images
+
+References: [FastMCP Servers docs](https://gofastmcp.com/servers/fastmcp#images), [GitHub examples](https://github.com/jlowin/fastmcp/blob/main/examples/image_tool.py)
+
+FastMCP provides first‑class support for image content via its `Image` helper class and by returning raw bytes with an explicit MIME type.
+
+### As a Tool
+
+```python
+from fastmcp import FastMCP, Image
+from PIL import Image as PILImage
+import io
+
+mcp = FastMCP("ImageDemo")
+
+@mcp.tool()
+def generate_image(width: int, height: int, color: str) -> Image:
+    """Generate a solid‑color PNG image."""
+    img = PILImage.new("RGB", (width, height), color=color)
+    buf = io.BytesIO()
+    img.save(buf, format="PNG")
+    return Image(data=buf.getvalue(), format="png")
+```
+
+### As a Resource
+
+```python
+@mcp.resource(
+    uri="images://logo",
+    mime_type="image/png"
+)
+def get_logo() -> bytes:
+    """Serve the company logo as PNG bytes."""
+    with open("assets/logo.png", "rb") as f:
+        return f.read()
+```
+
+---
+
+## 7. Basic Data Structures & Classes
+
+References: [FastMCP SDK source](https://github.com/jlowin/fastmcp/tree/main/fastmcp) for reference
+
+* **`FastMCP`**: core server container
+* **`ToolDefinition`**, **`ResourceDefinition`**, **`PromptDefinition`**: internal metadata
+* **`Context`**: passed into async tools for logging, progress, sampling, and resource reads
+* **`Image`**: helper class to wrap image bytes for clients
+

aixtools-0.1.1/.roo/rules/rules.md

@@ -0,0 +1,76 @@
+### Architecture
+
+- You MUST NOT over-engineer
+- Always prefer simplicity and direct approaches, instead of unnecessary abstractions.
+
+### Documentation
+
+- There SHOULD be a `README.md` with the typical sections.
+- The files `PROMPT_*.md` have the prompts for LLMs. You MUST NOT read or edit this file
+- Design documents MUST be saved as markdown in `docs/design`
+- Documentation SHOULD be simple and to the point. Do not write unnecessary explanations or diagrams.
+- When describing, avoid bullet points
+- Use diagrams only when necessary to clarify. Do not draw mermaid diagrams if you have two classes.
+- Do not write a "File Structure" section
+
+### Python code style
+
+- Type hints: 
+  - you MUST use type hints in functions and methods signatures
+  - you MUST use new way of defining types; e.g. " `dict`, `list`, `| None`, `any`, instead of the old `from typing import Dict, Optional, Any`
+- Docstrings: SHOULD be short but informative. Multi-line comments just saying the same as the signature are not useful
+- Files operations MUST use pathlib's `Path` instead of `str` / `import os`
+- Classes for data: You SHOULD use Pydantic classes or dataclasses instead of `dict` structures, or "record classes" (a class that only has fields and no functionality).
+- Enums: Do not hard-code string values, use `Enum` objects, e.g. `MyEnum(str, Enum)` for better serialization
+- Code line length: The lines SHOULD be coded for modern monitors (not 80 character terminals from 1960). Don't spread one statement to multiple lines unless really necessary for clarity.
+- Code lint:
+  - The effective line length for is infinite
+  - You SHOULD remove unused imports
+  - Functions and methods SHOULD be sorted alphabetically (except underscores)
+- Code files:
+  - SHOULD not exceed 500 lines. Refactor code if it's too long.
+  - Write classes (and enums) into their own files whenever possible.
+- DRY: Do not repeat yourself
+- Consider `match / case` instead of multiple `elif` statements
+- `config.py`: Config variables
+  - You SHOULD store configuration variables and defaults in a file called `config.py`.
+  - Also read the variables from `.env`.
+  - Simple values should be just be set (not configured).
+  - You SHOULD NOT create functions in `config.py`
+- `__str__()`: Classes SHOULD be "printable" so they are easier to understand when developing and debugging
+- `__init__.py`: Don't write unnecessary comments, versions, etc. in `__init__` files. If an empty one can do the trick, that's fine.
+
+### Utility scripts
+
+You SHOULD create scripts to:
+
+- `scripts/config.sh`: Set `PROJECT_DIR` and other project variables (re-export them). Read `.env`, activate virtual environment. All other scripts source `config.sh` to avoid duplicating the same code in every script.
+- `scripts/run.sh`: To run the program (particularly if it's a server)
+- `scripts/lint.sh`: To run linter
+- `scripts/test.sh`: To execute all test cases
+- Not having an `.env` or a `.venv` is an error, they are not optional.
+- When creating scripts follow the "no news is good news" principle, i.e. no unnecessary `echo` commands
+
+### Python packages
+
+- Use `uv` instead of `pip`
+- Use `ruff` instead of `black`
+
+### Python testing rules
+
+- You SHOULD use Python's unit test instead of `pytest`
+- You SHOULD Put all test files in a `tests` directory
+- You MUST create a `scripts/test.sh` to run all test cases.
+  - `scripts/test_unit.sh` to run all unit test cases
+  - `scripts/test_integration.sh` to run all integration cases (if any)
+- Any data necessary for testing MUST be in `tests/data`
+
+- For "simple examples" you MAY use Jupyter notebooks rather than isolated scripts
+ 
+### Bash
+
+- You MUST start shell script with these two lines:
+```
+#!/bin/bash -eu
+set -o pipefail
+```

aixtools-0.1.1/.vscode/settings.json

@@ -0,0 +1,8 @@
+{
+    "[python]": {
+        "editor.formatOnType": true,
+        "editor.defaultFormatter": "charliermarsh.ruff",
+    },
+    "python.testing.pytestEnabled": false,
+    "python.testing.unittestEnabled": false,
+}

{aixtools-0.1.0 → aixtools-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: aixtools
-Version: 0.1.0
+Version: 0.1.1
 Summary: Tools for AI exploration and debugging
 Requires-Python: >=3.11.2
 Description-Content-Type: text/markdown