afsar 1.0__tar.gz

afsar-1.0/.gitignore

@@ -0,0 +1,220 @@
+# 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
+*.lcov
+.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/*
+!.pixi/config.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule*
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# 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/Zensical 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/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

afsar-1.0/.pre-commit-config.yaml

@@ -0,0 +1,44 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.17.0
+    hooks:
+      - id: ruff
+        args: [ --fix ]
+      - id: ruff-format
+
+  - repo: local
+    hooks:
+      - id: check-ops-plain-ascii
+        name: check-ops-plain-ascii
+        entry: >-
+          python3 -c "import sys, pathlib; errors = [f'{p}:{i+1} non-ascii char {c!r}' for p in sys.argv[1:] for i, line in enumerate(pathlib.Path(p).read_text(encoding='utf-8', errors='replace').splitlines()) for c in line if ord(c) > 127]; sys.exit('\n'.join(errors)) if errors else sys.exit(0)"
+        language: system
+        files: (^|/)ops/.*\.(sh|py|bash|zsh)$|(^|/)ops/deploy$
+
+      - id: code-limits
+        name: check-module-and-function-limits
+        entry: /Users/talfranji/venv/afsar/bin/python ops/check_code_limits.py --max-module-lines 600 --max-function-lines 220
+        language: system
+        types: [python]
+        pass_filenames: false
+
+      - id: xenon
+        name: xenon
+        entry: /Users/talfranji/venv/afsar/bin/xenon --no-assert -b C -m C -a A src ops -i "tests"
+        language: system
+        types: [python]
+        pass_filenames: false
+
+      - id: mypy
+        name: mypy
+        entry: /Users/talfranji/venv/afsar/bin/mypy src ops tests
+        language: system
+        types: [python]
+        pass_filenames: false
+
+      - id: pytest
+        name: pytest
+        entry: /Users/talfranji/venv/afsar/bin/pytest -v
+        language: system
+        types: [python]
+        pass_filenames: false

afsar-1.0/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.5
+Name: afsar
+Version: 1.0
+Summary: LLM API library for students utilizing local agents or remote APIs
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: mypy>=1.9.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.6.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.17.0; extra == 'dev'
+Requires-Dist: xenon>=0.9.0; extra == 'dev'
+Provides-Extra: schema
+Requires-Dist: pydantic>=2.0.0; extra == 'schema'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="src/afsar/resources/afsar.png" alt="afsar logo" width="180" />
+</p>
+
+# afsar
+
+A simple, student-friendly procedural Python library providing a uniform interface to LLMs. `afsar` prioritizes installed local coding agents (`claude-code`, `antigravity`) so students can use their existing agents and tools, and smoothly falls back to remote cloud APIs (`Gemini`, `OpenAI`).
+
+---
+
+## Installation
+
+Install via pip:
+
+```bash
+pip install afsar
+```
+
+---
+
+## Quickstart
+
+### 1. Basic Text Query
+
+```python
+import afsar
+
+# Setup is explicit and required once before asking
+afsar.setup()
+
+answer = afsar.ask("How do you define a function in Python?")
+print(answer)
+```
+
+### 2. Structured Output with `@dataclass`
+
+You don't need Pydantic to get typed objects. Standard Python dataclasses work out of the box:
+
+```python
+from dataclasses import dataclass
+import afsar
+
+
+@dataclass
+class QuizQuestion:
+    question: str
+    points: int
+    topic: str
+
+
+afsar.setup()
+quiz = afsar.ask("Create a beginner Python question.", schema=QuizQuestion)
+
+print(quiz.question)
+print(f"Points: {quiz.points}")
+print(f"Topic: {quiz.topic}")
+```
+
+### 3. Raw JSON Output
+
+If you just want a JSON-formatted string:
+
+```python
+import afsar
+
+afsar.setup()
+raw_json = afsar.ask("List 3 Python data structures.", format="json")
+print(raw_json)  # Returns clean JSON string
+```
+
+### 4. Student Coding Exercises (Local Tools)
+
+When using local agents (`claude` or `agy`), `afsar` defaults to `tools=["python", "files"]`. This allows asking the agent to write and test code locally:
+
+```python
+import afsar
+
+afsar.setup()
+response = afsar.ask(
+    "Write a solution to check if a word is a palindrome, save it to palindrome.py, run it with python, and show the result."
+)
+print(response)
+```
+
+---
+
+## Remote APIs (Gemini & OpenAI)
+
+Remote models do not support local file or execution tools. When connecting to remote APIs, explicitly pass `tools=[]`:
+
+```python
+import afsar
+
+# Using Gemini
+afsar.setup(provider="gemini", api_key="YOUR_GEMINI_KEY", tools=[])
+
+# Or using OpenAI
+afsar.setup(provider="openai", api_key="YOUR_OPENAI_KEY", tools=[])
+
+answer = afsar.ask("Explain recursion in simple terms.")
+print(answer)
+```
+
+---
+
+## Auto-Detection & Priority
+
+Calling `afsar.setup()` without arguments automatically searches for available providers in this order:
+
+1. **Claude Code CLI** (`claude`) in `PATH`
+2. **Antigravity CLI** (`agy`) in `PATH`
+3. **Google Gemini** (`GEMINI_API_KEY` in environment)
+4. **OpenAI** (`OPENAI_API_KEY` in environment)
+
+You can override the provider explicitly in code:
+
+```python
+afsar.setup(provider="agy")
+```
+
+Or via the `AFSAR_PROVIDER` environment variable:
+
+```bash
+export AFSAR_PROVIDER=agy
+```
+
+---
+
+## Exceptions
+
+- `NotSetupError`: Raised if `afsar.ask()` is called before `afsar.setup()`.
+- `UnsupportedFeatureError`: Raised if requesting local tools (`tools=["python", "files"]`) on remote API providers.
+- `ModelNotFoundError`: Raised if no supported local CLI or remote API key is discovered.
+- `ExecutionError`: Raised if a CLI command or remote API request fails.

afsar-1.0/README.md

@@ -0,0 +1,134 @@
+<p align="center">
+  <img src="src/afsar/resources/afsar.png" alt="afsar logo" width="180" />
+</p>
+
+# afsar
+
+A simple, student-friendly procedural Python library providing a uniform interface to LLMs. `afsar` prioritizes installed local coding agents (`claude-code`, `antigravity`) so students can use their existing agents and tools, and smoothly falls back to remote cloud APIs (`Gemini`, `OpenAI`).
+
+---
+
+## Installation
+
+Install via pip:
+
+```bash
+pip install afsar
+```
+
+---
+
+## Quickstart
+
+### 1. Basic Text Query
+
+```python
+import afsar
+
+# Setup is explicit and required once before asking
+afsar.setup()
+
+answer = afsar.ask("How do you define a function in Python?")
+print(answer)
+```
+
+### 2. Structured Output with `@dataclass`
+
+You don't need Pydantic to get typed objects. Standard Python dataclasses work out of the box:
+
+```python
+from dataclasses import dataclass
+import afsar
+
+
+@dataclass
+class QuizQuestion:
+    question: str
+    points: int
+    topic: str
+
+
+afsar.setup()
+quiz = afsar.ask("Create a beginner Python question.", schema=QuizQuestion)
+
+print(quiz.question)
+print(f"Points: {quiz.points}")
+print(f"Topic: {quiz.topic}")
+```
+
+### 3. Raw JSON Output
+
+If you just want a JSON-formatted string:
+
+```python
+import afsar
+
+afsar.setup()
+raw_json = afsar.ask("List 3 Python data structures.", format="json")
+print(raw_json)  # Returns clean JSON string
+```
+
+### 4. Student Coding Exercises (Local Tools)
+
+When using local agents (`claude` or `agy`), `afsar` defaults to `tools=["python", "files"]`. This allows asking the agent to write and test code locally:
+
+```python
+import afsar
+
+afsar.setup()
+response = afsar.ask(
+    "Write a solution to check if a word is a palindrome, save it to palindrome.py, run it with python, and show the result."
+)
+print(response)
+```
+
+---
+
+## Remote APIs (Gemini & OpenAI)
+
+Remote models do not support local file or execution tools. When connecting to remote APIs, explicitly pass `tools=[]`:
+
+```python
+import afsar
+
+# Using Gemini
+afsar.setup(provider="gemini", api_key="YOUR_GEMINI_KEY", tools=[])
+
+# Or using OpenAI
+afsar.setup(provider="openai", api_key="YOUR_OPENAI_KEY", tools=[])
+
+answer = afsar.ask("Explain recursion in simple terms.")
+print(answer)
+```
+
+---
+
+## Auto-Detection & Priority
+
+Calling `afsar.setup()` without arguments automatically searches for available providers in this order:
+
+1. **Claude Code CLI** (`claude`) in `PATH`
+2. **Antigravity CLI** (`agy`) in `PATH`
+3. **Google Gemini** (`GEMINI_API_KEY` in environment)
+4. **OpenAI** (`OPENAI_API_KEY` in environment)
+
+You can override the provider explicitly in code:
+
+```python
+afsar.setup(provider="agy")
+```
+
+Or via the `AFSAR_PROVIDER` environment variable:
+
+```bash
+export AFSAR_PROVIDER=agy
+```
+
+---
+
+## Exceptions
+
+- `NotSetupError`: Raised if `afsar.ask()` is called before `afsar.setup()`.
+- `UnsupportedFeatureError`: Raised if requesting local tools (`tools=["python", "files"]`) on remote API providers.
+- `ModelNotFoundError`: Raised if no supported local CLI or remote API key is discovered.
+- `ExecutionError`: Raised if a CLI command or remote API request fails.