ag2-assistant 0.5.0__tar.gz

ag2_assistant-0.5.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 ag2ai organization, i.e., https://github.com/ag2ai, owners.
+
+   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.

ag2_assistant-0.5.0/PKG-INFO

@@ -0,0 +1,280 @@
+Metadata-Version: 2.4
+Name: ag2-assistant
+Version: 0.5.0
+Summary: AG2 Assistant — a personal AI assistant powered by AG2's framework
+License-Expression: Apache-2.0
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ag2[acp,ddgs,gemini,openai]>=1.0.0b0
+Requires-Dist: typer>=0.15.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: mcp>=1.9.0
+Requires-Dist: httpx>=0.28.0
+Requires-Dist: beautifulsoup4>=4.12.0
+Requires-Dist: cronsim>=2.7
+Requires-Dist: cron-descriptor>=1.4
+Requires-Dist: fastapi>=0.115.0
+Requires-Dist: uvicorn[standard]>=0.34.0
+Requires-Dist: python-telegram-bot>=21.0
+Requires-Dist: discord.py>=2.4
+Requires-Dist: slack-bolt>=1.18
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.25.0; extra == "dev"
+Requires-Dist: ruff<0.16,>=0.15.18; extra == "dev"
+Requires-Dist: pre-commit>=4.0.0; extra == "dev"
+Provides-Extra: google
+Requires-Dist: google-api-python-client>=2.0; extra == "google"
+Requires-Dist: google-auth>=2.0; extra == "google"
+Requires-Dist: google-auth-oauthlib>=1.0; extra == "google"
+Requires-Dist: pypdf>=5.0; extra == "google"
+Dynamic: license-file
+
+# AG2 Assistant
+
+An open-source personal AI assistant powered by [AG2](https://ag2.ai)'s Beta framework, built in Python.
+
+> Public product name: **AG2 Assistant**. `ag2-assistant` remains the internal package, CLI command, and data-dir name.
+
+AG2 Assistant is a web app (with optional messaging-channel and CLI front-ends) that acts as your personal AI agent — it searches the web, runs code, generates images, reads your project files, and runs scheduled tasks, all while showing its work in the open. Every reply is a projection of the underlying AG2 event stream.
+
+## Quick Start
+
+### 1. Install
+
+The quickest way — one line, no clone, no Python setup (the script installs [uv](https://docs.astral.sh/uv/) if needed, and uv brings its own Python):
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/ag2ai/ag2-assistant/main/scripts/install.sh | sh
+```
+
+On Windows:
+
+```powershell
+powershell -ExecutionPolicy Bypass -c "irm https://raw.githubusercontent.com/ag2ai/ag2-assistant/main/scripts/install.ps1 | iex"
+```
+
+Re-run the same script any time to upgrade. Or clone for a development checkout:
+
+```bash
+git clone https://github.com/ag2ai/ag2-assistant.git
+cd ag2-assistant
+python -m venv .venv
+source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+The repo also ships a `uv.lock`, so `uv run ag2-assistant …` and `uv run pytest` work without setting up a venv yourself.
+
+Or just install the CLI globally yourself, no clone (git = latest commit; releases publish to PyPI from the first tagged version):
+
+```bash
+uv tool install "git+https://github.com/ag2ai/ag2-assistant.git"   # or: pipx install "git+https://github.com/ag2ai/ag2-assistant.git"
+```
+
+Prefer to run it as an always-on container? See [Deployment](#deployment).
+
+### 2. Run
+
+```bash
+ag2-assistant run        # gateway + web UI (+ any configured channels), one process
+```
+
+Then open **http://localhost:8800/** and follow the first-run setup — six short steps:
+
+1. **Welcome** — your name.
+2. **About you** — location, working hours, preferred answer style (all optional, shared by every profile).
+3. **Connect** — add a provider key (Gemini is the default and recommended — get one at [aistudio.google.com](https://aistudio.google.com/apikey)), or **sign in with ChatGPT** to run on your existing ChatGPT subscription instead of an API key. You can't continue until one of the two works.
+4. **Profiles** — create at least one profile (e.g. *Personal*), each a colour-coded, fully isolated workspace.
+5. **Set up** — per profile: an optional folder to grant it read access to, and the kinds of work you want help with.
+6. **Ready** — pick a theme and start.
+
+Everything here is changeable later in **Settings**.
+
+> Prefer to set the key up front? Put `GEMINI_API_KEY=your-key` in a `.env` (see `.env.example`) before running — keys can come from the environment, and setup will pick them up.
+
+To serve the API/UI without any messaging channels, use `ag2-assistant gateway` instead of `run`.
+
+## Profiles
+
+The assistant is organised into **profiles** — separate, colour-coded workspaces you switch between from the sidebar (or ⌘1–⌘9). A profile has its own chats, tasks, memory, files, folder grants, MCP servers and permissions, so a *Work* profile never sees your *Personal* one.
+
+Provider keys, the model configuration, and who you are are shared install-wide (the global `~/.ag2assistant/config.yaml`); everything else is per profile, overlaid from that profile's `~/.ag2assistant/profiles/<id>/config.yaml`. State lives in `~/.ag2assistant/profiles/<id>/` and generated files in `~/Documents/AG2 Assistant/<Profile>/`. Override the install root with `--data-dir` (or `AG2ASSISTANT_DATA_DIR`).
+
+## The web app
+
+The primary interface is the Svelte web UI served at `/` (→ `/app`). It includes:
+
+- **Chat** — multi-turn conversations with live, streamed agent events (tool calls, code runs, web searches) rendered inline. Attach images or documents and ask about them.
+- **Rich answers** — where structure beats prose, the agent renders a live surface instead: a weather panel, market board, news digest, agenda, inbox brief, or decision matrix.
+- **Steer or stop a turn while it runs** — send a message mid-turn and the agent folds it into the work it's already doing, or hit **Stop** to end the turn — keeping whatever it produced up to that point, so the conversation carries on with that context.
+- **Tasks** — standing jobs the agent runs on a schedule. A task is just a prompt + an optional model + a schedule (hourly/daily/weekly/weekdays, custom cron, one-shot, or manual), editable in place at any time — or created for you by the agent from chat. Every run is a real chat: open it to watch the agent work, steer it mid-run, stop it, or keep talking in it after it finishes. Recent run outcomes feed the next run, and tasks created from Telegram/Slack/Discord report their results back there.
+- **It asks when it's unsure** — mid-task the agent can put a question to you (with tappable options) and resume with your answer, in the web UI or on a connected channel.
+- **Image generation** — generated images are saved to the shared workspace and shown as clickable inline thumbnails.
+- **Files** — browse, preview, download and delete everything the assistant has saved.
+- **Memory** — the assistant passively learns your preferences; 👍/👎 feedback (with a reason) feeds a memory-aware learner that dedupes and prunes conflicting notes.
+- **Folders** — register folders outside the workspace and grant a profile (or a single chat) **read** or **read + write** access, so the assistant can work with your code/notes. Access is granted, never blanket — a first-touch prompt can mint a grant on the fly.
+- **Permissions** — you decide what commands it can run: approve shell commands once or always.
+- **Voice** — talk to the assistant (Gemini Live / OpenAI realtime) over a browser audio bridge.
+- **Usage** — tokens and estimated cost, per profile and across the install.
+- **Settings** — models, API keys, voice, MCP servers, Google, channels, folders, permissions, profiles, and re-run setup.
+
+### Models
+
+Set up as many named model configurations as you like (Gemini, OpenAI, Anthropic, Ollama, or any OpenAI-compatible endpoint), test them, and switch the active one at any time in **Settings → Models**. Two OpenAI paths are supported: a normal **API key**, or **Sign in with ChatGPT**, which runs on your ChatGPT/Codex subscription instead of paying per token (unofficial — see `ag2-assistant auth --help`).
+
+### Google
+
+Connect Google in Settings and the assistant can search and read your Gmail, draft and send mail (with your approval), read and create calendar events, and read Drive/Docs/Sheets.
+
+## CLI
+
+The web app is the main experience, but the CLI is handy for quick one-shots and scripting:
+
+```bash
+ag2-assistant run                       # everything in one process (gateway + UI + channels)
+ag2-assistant gateway                   # REST + WebSocket API + web UI only
+ag2-assistant chat                      # interactive multi-turn chat in the terminal
+ag2-assistant agent "message"           # single-shot prompt → reply
+ag2-assistant onboard                   # first-run interview (name, location, hours, style)
+ag2-assistant version                   # show version
+
+ag2-assistant profiles list             # profiles: list / create
+ag2-assistant profile show              # the active profile's memory; `profile clear` wipes it
+ag2-assistant permissions list          # folder + command grants: allow / revoke / block / unblock
+ag2-assistant auth login                # sign in with a ChatGPT subscription (also: logout, status)
+ag2-assistant google login              # connect Gmail/Calendar/Drive (also: logout, status)
+
+ag2-assistant telegram                  # run on Telegram   (needs TELEGRAM_BOT_TOKEN)
+ag2-assistant discord                   # run on Discord    (needs DISCORD_BOT_TOKEN)
+ag2-assistant slack                     # run on Slack      (needs SLACK_BOT_TOKEN + SLACK_APP_TOKEN)
+```
+
+Channel tokens can also be pasted into **Settings → Channels** instead of the environment.
+
+### Examples
+
+```bash
+ag2-assistant agent "What's the current AG2 version? Search the web."
+ag2-assistant agent "Calculate the first 20 Fibonacci numbers"
+ag2-assistant agent "Compare FastAPI vs Flask. Search the web for current benchmarks."
+```
+
+## Deployment
+
+The Quick Start above is the developer setup. For other ways to run it — see
+[docs/deployment.md](docs/deployment.md) for the full guide:
+
+| Tier | For | How |
+|------|-----|-----|
+| **Contributor** | hacking on the code | `git clone` + `pip install -e ".[dev]"` |
+| **CLI user** | running locally, no clone | `curl -fsSL https://raw.githubusercontent.com/ag2ai/ag2-assistant/main/scripts/install.sh \| sh` |
+| **Self-hosted** | an always-on instance | `docker compose up -d` |
+| **PyPI** | released versions | `uv tool install ag2-assistant` (from the first release) |
+
+### Docker (self-hosted)
+
+No clone needed — tagged releases publish a prebuilt image to GHCR (`:latest` moves on
+each release):
+
+```bash
+docker run -d --name ag2-assistant -p 8800:8800 \
+  -v ag2_data:/data -v ag2_workspace:/workspace \
+  ghcr.io/ag2ai/ag2-assistant:latest
+```
+
+Or from a checkout, with Compose:
+
+```bash
+cp .env.example .env         # add a provider key (e.g. GEMINI_API_KEY) — optional
+docker compose up -d         # build + run; open http://localhost:8800/
+```
+
+State and the agent's file workspace persist in named volumes. Code execution runs
+in-container by default (no host Docker socket); see
+[docs/deployment.md](docs/deployment.md) for the docker-out-of-docker option and channel
+setup.
+
+> The gateway has no built-in auth. Only expose port 8800 beyond localhost behind a reverse
+> proxy that handles TLS and authentication.
+
+## Running Tests
+
+```bash
+pytest                  # the default suite (integration tests are excluded automatically)
+pytest -m integration   # only the tests that call a real LLM / network (needs API keys)
+pytest -m ""            # everything
+```
+
+## Architecture
+
+**[docs/architecture.md](docs/architecture.md)** is the full system design — every service, agent, endpoint, event type, data flow, and on-disk store — with a companion diagram, [docs/architecture.svg](docs/architecture.svg):
+
+[![AG2 Assistant architecture](docs/architecture.svg)](docs/architecture.md)
+
+A text sketch of the same shape:
+
+```
+  Web UI (Svelte)   ·   Messaging channels   ·   CLI
+         |  REST + WebSocket (event stream)        |
+    +-----------+
+    |  Gateway  |  (FastAPI: /api/p/{profile}/message, /api/p/{profile}/stream,
+    |           |   /api/health, /app)
+    +-----------+
+         |  per-profile, per-chat isolation; events streamed to every client
+    +-----------+
+    |   Agent   |  (AG2 + Gemini / OpenAI / Anthropic / Ollama)
+    |   Tools   |  (web search, web fetch, weather, markets, shell, code exec,
+    |           |   image gen, files, folder read/write, tasks/scheduling, Google,
+    |           |   skills, your own MCP servers)
+    +-----------+
+         |
+    +-----------+
+    |  Memory   |  (preferences learned passively + from 👍/👎 feedback → SQLite)
+    +-----------+
+```
+
+Install-wide state lives under `~/.ag2assistant/` — the global `config.yaml` (model configs live in its `llm_configs:` section), `secrets.json` (provider keys), and the profile registry; each profile keeps its own `config.yaml` overlay, chats, tasks and memory in `~/.ag2assistant/profiles/<id>/`, and its generated files in `~/Documents/AG2 Assistant/<Profile>/`. The install root is overridable with `--data-dir` / `AG2ASSISTANT_DATA_DIR`.
+
+## Project Status
+
+- [x] Core agent with multi-provider support (Gemini, OpenAI, Anthropic, Ollama)
+- [x] Named model configurations + "Sign in with ChatGPT" subscription auth
+- [x] Profiles — isolated, colour-coded workspaces (own chats, tasks, memory, files)
+- [x] CLI (run, gateway, chat, agent, onboard, profiles, permissions, auth, google)
+- [x] Tools (web search, web fetch, weather, markets, shell, code execution, image generation, files)
+- [x] Memory — passively learns preferences and from 👍/👎 feedback; persists across chats
+- [x] Multi-turn conversations (per-chat isolation)
+- [x] Gateway (REST + WebSocket event-stream API)
+- [x] Web UI — chat, tasks, files, images, voice, memory, usage, permissions, onboarding, settings
+- [x] Generative UI — rich live surfaces (weather, markets, news, agenda, inbox, decisions)
+- [x] Tasks — standing scheduled jobs (manual/once/cron); every run is a steerable, stoppable chat
+- [x] Human-in-the-loop — the agent asks you questions and waits, on any surface
+- [x] Permissions — shell-command approval (folder access is Folders + Grants)
+- [x] Voice (Gemini Live / OpenAI realtime over a browser audio bridge)
+- [x] Folders — install-wide registry with per-profile/per-chat read & read+write grants; user-extensible MCP servers
+- [x] Google — Gmail, Calendar, Drive
+- [x] Channels: Telegram, Discord, Slack (DM + group @mention gating)
+- [x] Skills — searches & installs from the skills.sh registry, runs them
+- [ ] More channels (WhatsApp)
+- [ ] Desktop / mobile clients
+
+## Documentation
+
+- [Architecture](docs/architecture.md) — full system design: services, agents, endpoints, event model, data flow ([diagram](docs/architecture.svg))
+- [Usage Guide](docs/usage.md) — CLI commands, configuration, channels
+- [Deployment](docs/deployment.md) — install tiers, Docker/Compose, self-hosting
+
+## Contributing
+
+Contributions are welcome — see [CONTRIBUTING.md](CONTRIBUTING.md) to get set up
+and [AGENTS.md](AGENTS.md) for the development guidelines. To report a security
+issue, follow [.github/SECURITY.md](.github/SECURITY.md) (please don't open a
+public issue).
+
+## License
+
+[Apache License 2.0](LICENSE)