agentkai 0.1.0__tar.gz

agentkai-0.1.0/LICENSE

@@ -0,0 +1,176 @@
+                                 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

agentkai-0.1.0/PKG-INFO

@@ -0,0 +1,139 @@
+Metadata-Version: 2.4
+Name: agentkai
+Version: 0.1.0
+Summary: Open-source personal AI agent — model-agnostic, with tools, memory, scheduler and a local dashboard
+License: Apache-2.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: litellm>=1.60
+Requires-Dist: typer>=0.9
+Requires-Dist: rich>=13
+Requires-Dist: fastapi>=0.110
+Requires-Dist: uvicorn>=0.29
+Requires-Dist: pydantic>=2
+Requires-Dist: pyyaml>=6
+Requires-Dist: playwright>=1.40
+Requires-Dist: httpx>=0.27
+Requires-Dist: discord.py>=2.4
+Requires-Dist: websockets>=12
+Provides-Extra: voice
+Requires-Dist: faster-whisper>=1.0; extra == "voice"
+Provides-Extra: test
+Requires-Dist: pytest>=8; extra == "test"
+Requires-Dist: pytest-asyncio>=0.23; extra == "test"
+Dynamic: license-file
+
+<p align="center">
+  <img src="assets/agentkai-logo.gif" width="160" height="160" alt="agentkai logo — animated fluffy mascot">
+</p>
+
+# agentkai
+
+An open-source personal AI agent that runs on your own computer.
+Model-agnostic by design: bring your own model — Claude, Gemini, GPT,
+Ollama (local), GLM, or anything LiteLLM speaks — and the agent keeps
+the same tools, memory, scheduler, and dashboard.
+
+```
+                    ┌─────────────┐
+                    │    You      │
+                    └──────┬──────┘
+        ┌──────────────────┼──────────────────┐
+        ▼                  ▼                  ▼
+  ┌───────────┐     ┌─────────────┐     ┌─────────────┐
+  │   CLI     │     │  Dashboard  │     │   Gateway   │
+  │agentkai   │     │ 127.0.0.1   │     │ Telegram /  │
+  │run · chat │     │ token-auth  │     │ Discord /   │
+  └─────┬─────┘     └──────┬──────┘     │ WebChat /   │
+        │                  │            │ WhatsApp*   │
+        └──────────────────┼────────────┴──────┬──────┘
+                           ▼                   ▼
+                    ┌──────────────────────────────┐
+                    │        Agent loop            │
+                    │  think → tool-call → observe │
+                    │  streaming · timeouts ·      │
+                    │  approval gates · event log  │
+                    └──────────────┬───────────────┘
+        ┌────────────┬─────────────┼──────────────┬────────────┐
+        ▼            ▼             ▼              ▼            ▼
+  ┌──────────┐ ┌──────────┐ ┌────────────┐ ┌──────────┐ ┌──────────┐
+  │ Providers│ │  Tools   │ │  Browser   │ │  Memory  │ │Scheduler │
+  │ Claude   │ │ exec etc │ │ Chromium   │ │ markdown │ │ cron ·   │
+  │ Gemini   │ │ MCP      │ │ real pages │ │ SOUL/USER│ │ heartbeat│
+  │ GPT/Oll. │ │ 12 skills│ │ clicks/forms│ │ daily log│ │ dreaming │
+  └──────────┘ └──────────┘ └────────────┘ └──────────┘ └──────────┘
+```
+
+\* WhatsApp via an experimental user-run bridge sidecar.
+
+## Features
+
+- **Model-agnostic** — aliases (`claude`, `gemini`, `gpt`, `glm`,
+  `local`) with fallbacks, capability probing, BYOK keys that are never
+  logged. Fully offline with Ollama.
+- **Real tools** — shell/filesystem (root-scoped, blocklisted), a real
+  Chromium browser, MCP client (stdio + SSE), 12 bundled skills (Gmail,
+  Calendar, GitHub, Spotify, places, images, voice, media, payments,
+  shopping, travel, health).
+- **Permission gates** — risk-based allow/ask/deny on every tool call,
+  audited. Unattended jobs can never run high-risk tools.
+- **Markdown memory** — SOUL/USER/MEMORY.md, daily logs, people & groups,
+  keyword search. Plain files you can edit and git.
+- **Scheduler** — cron/at jobs, heartbeat check-ins, nightly dreaming
+  (memory consolidation), all in SQLite.
+- **Messaging gateway** — Telegram, Discord, built-in WebChat, and an
+  experimental WhatsApp bridge; per-session isolation, owner approvals
+  via `APPROVE`/`DENY`.
+- **Local dashboard** — FastAPI on 127.0.0.1 only, per-launch token,
+  offline SPA, live SSE streaming, run replay.
+- **Voice & media** — faster-whisper / OpenAI STT+TTS; image generation
+  via OpenAI (paid) or local Stable Diffusion. Honest errors when
+  nothing is configured — nothing faked.
+- **Devices & goals** — pair your phone via the companion-app contract;
+  durable goals and tracked items with a daily briefing prompt.
+
+## Quick start
+
+```bash
+pip install agentkai
+export ANTHROPIC_API_KEY=...   # or GEMINI_API_KEY / OPENAI_API_KEY / ZHIPUAI_API_KEY
+agentkai run "summarize what's in ~/Documents" --model claude
+agentkai dashboard             # local UI at http://127.0.0.1:8931/
+```
+
+No key? Install [Ollama](https://ollama.com), `ollama pull qwen3:32b`,
+then `agentkai run "hello" --model local` — fully offline.
+
+Full guide: [`docs/quickstart.md`](docs/quickstart.md) ·
+all docs: [`docs/index.md`](docs/index.md)
+
+## Layout
+
+- `src/agentkai/` — the package: agent loop, providers, tools, browser,
+  channels, dashboard, devices, memory, scheduler, skills, voice, media,
+  goals, widgets
+- `docs/` — user documentation for every feature (original docs)
+- `research/` — architecture research and case studies
+- `examples/` — example configs and skills
+
+## Status
+
+v0.1.0 — core flows (agent runs, tools, memory, scheduler, dashboard,
+channels) are implemented and tested. Items marked **experimental** in
+the docs (WhatsApp bridge, video generation) are real code with real
+limits. See [`docs/troubleshooting.md`](docs/troubleshooting.md) for
+known gaps.
+
+## Development
+
+```bash
+git clone https://github.com/Bilal-Junaid-Jiwani/agentkai
+cd agentkai
+python -m venv .venv && .venv/bin/pip install -e ".[test,voice]"
+.venv/bin/python -m pytest tests/   # full suite
+```
+
+## License
+
+Apache-2.0

agentkai-0.1.0/README.md

@@ -0,0 +1,113 @@
+<p align="center">
+  <img src="assets/agentkai-logo.gif" width="160" height="160" alt="agentkai logo — animated fluffy mascot">
+</p>
+
+# agentkai
+
+An open-source personal AI agent that runs on your own computer.
+Model-agnostic by design: bring your own model — Claude, Gemini, GPT,
+Ollama (local), GLM, or anything LiteLLM speaks — and the agent keeps
+the same tools, memory, scheduler, and dashboard.
+
+```
+                    ┌─────────────┐
+                    │    You      │
+                    └──────┬──────┘
+        ┌──────────────────┼──────────────────┐
+        ▼                  ▼                  ▼
+  ┌───────────┐     ┌─────────────┐     ┌─────────────┐
+  │   CLI     │     │  Dashboard  │     │   Gateway   │
+  │agentkai   │     │ 127.0.0.1   │     │ Telegram /  │
+  │run · chat │     │ token-auth  │     │ Discord /   │
+  └─────┬─────┘     └──────┬──────┘     │ WebChat /   │
+        │                  │            │ WhatsApp*   │
+        └──────────────────┼────────────┴──────┬──────┘
+                           ▼                   ▼
+                    ┌──────────────────────────────┐
+                    │        Agent loop            │
+                    │  think → tool-call → observe │
+                    │  streaming · timeouts ·      │
+                    │  approval gates · event log  │
+                    └──────────────┬───────────────┘
+        ┌────────────┬─────────────┼──────────────┬────────────┐
+        ▼            ▼             ▼              ▼            ▼
+  ┌──────────┐ ┌──────────┐ ┌────────────┐ ┌──────────┐ ┌──────────┐
+  │ Providers│ │  Tools   │ │  Browser   │ │  Memory  │ │Scheduler │
+  │ Claude   │ │ exec etc │ │ Chromium   │ │ markdown │ │ cron ·   │
+  │ Gemini   │ │ MCP      │ │ real pages │ │ SOUL/USER│ │ heartbeat│
+  │ GPT/Oll. │ │ 12 skills│ │ clicks/forms│ │ daily log│ │ dreaming │
+  └──────────┘ └──────────┘ └────────────┘ └──────────┘ └──────────┘
+```
+
+\* WhatsApp via an experimental user-run bridge sidecar.
+
+## Features
+
+- **Model-agnostic** — aliases (`claude`, `gemini`, `gpt`, `glm`,
+  `local`) with fallbacks, capability probing, BYOK keys that are never
+  logged. Fully offline with Ollama.
+- **Real tools** — shell/filesystem (root-scoped, blocklisted), a real
+  Chromium browser, MCP client (stdio + SSE), 12 bundled skills (Gmail,
+  Calendar, GitHub, Spotify, places, images, voice, media, payments,
+  shopping, travel, health).
+- **Permission gates** — risk-based allow/ask/deny on every tool call,
+  audited. Unattended jobs can never run high-risk tools.
+- **Markdown memory** — SOUL/USER/MEMORY.md, daily logs, people & groups,
+  keyword search. Plain files you can edit and git.
+- **Scheduler** — cron/at jobs, heartbeat check-ins, nightly dreaming
+  (memory consolidation), all in SQLite.
+- **Messaging gateway** — Telegram, Discord, built-in WebChat, and an
+  experimental WhatsApp bridge; per-session isolation, owner approvals
+  via `APPROVE`/`DENY`.
+- **Local dashboard** — FastAPI on 127.0.0.1 only, per-launch token,
+  offline SPA, live SSE streaming, run replay.
+- **Voice & media** — faster-whisper / OpenAI STT+TTS; image generation
+  via OpenAI (paid) or local Stable Diffusion. Honest errors when
+  nothing is configured — nothing faked.
+- **Devices & goals** — pair your phone via the companion-app contract;
+  durable goals and tracked items with a daily briefing prompt.
+
+## Quick start
+
+```bash
+pip install agentkai
+export ANTHROPIC_API_KEY=...   # or GEMINI_API_KEY / OPENAI_API_KEY / ZHIPUAI_API_KEY
+agentkai run "summarize what's in ~/Documents" --model claude
+agentkai dashboard             # local UI at http://127.0.0.1:8931/
+```
+
+No key? Install [Ollama](https://ollama.com), `ollama pull qwen3:32b`,
+then `agentkai run "hello" --model local` — fully offline.
+
+Full guide: [`docs/quickstart.md`](docs/quickstart.md) ·
+all docs: [`docs/index.md`](docs/index.md)
+
+## Layout
+
+- `src/agentkai/` — the package: agent loop, providers, tools, browser,
+  channels, dashboard, devices, memory, scheduler, skills, voice, media,
+  goals, widgets
+- `docs/` — user documentation for every feature (original docs)
+- `research/` — architecture research and case studies
+- `examples/` — example configs and skills
+
+## Status
+
+v0.1.0 — core flows (agent runs, tools, memory, scheduler, dashboard,
+channels) are implemented and tested. Items marked **experimental** in
+the docs (WhatsApp bridge, video generation) are real code with real
+limits. See [`docs/troubleshooting.md`](docs/troubleshooting.md) for
+known gaps.
+
+## Development
+
+```bash
+git clone https://github.com/Bilal-Junaid-Jiwani/agentkai
+cd agentkai
+python -m venv .venv && .venv/bin/pip install -e ".[test,voice]"
+.venv/bin/python -m pytest tests/   # full suite
+```
+
+## License
+
+Apache-2.0

agentkai-0.1.0/pyproject.toml

@@ -0,0 +1,56 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "agentkai"
+version = "0.1.0"
+description = "Open-source personal AI agent — model-agnostic, with tools, memory, scheduler and a local dashboard"
+readme = "README.md"
+license = { text = "Apache-2.0" }
+requires-python = ">=3.10"
+dependencies = [
+    "litellm>=1.60",
+    "typer>=0.9",
+    "rich>=13",
+    "fastapi>=0.110",
+    "uvicorn>=0.29",
+    "pydantic>=2",
+    "pyyaml>=6",
+    "playwright>=1.40",
+    "httpx>=0.27",        # telegram channel + whatsapp sidecar HTTP
+    "discord.py>=2.4",    # discord channel
+    "websockets>=12",     # built-in webchat channel
+]
+
+[project.optional-dependencies]
+voice = ["faster-whisper>=1.0"]  # offline speech-to-text (local-whisper)
+test = ["pytest>=8", "pytest-asyncio>=0.23"]  # run the test suite
+
+[project.scripts]
+agentkai = "agentkai.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+# Non-Python files that must ship inside the wheel: dashboard SPA,
+# skill instructions + tool code (loaded from disk, not as packages),
+# and the channel/device/widget contract docs referenced by docs/.
+[tool.setuptools.package-data]
+agentkai = [
+    "dashboard/static/**/*",
+    "dashboard/API.md",
+    "channels/README.md",
+    "channels/static/**/*",
+    "channels/examples/**/*",
+    "devices/README.md",
+    "widgets/PROTOCOL.md",
+    "skills_bundle/*/SKILL.md",
+    "skills_bundle/*/tools.py",
+]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+markers = [
+    "real_browser: requires a real Chromium install (opt-in via AGENTKAI_REAL_BROWSER=1)",
+]

agentkai-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

agentkai-0.1.0/src/agentkai/__init__.py

@@ -0,0 +1,54 @@
+"""agentkai: model-agnostic personal AI agent."""
+from .agent import Agent, RunResult
+from .events import Event, EventLog, list_runs, replay, summarize
+from .permissions import Action, PermissionGate, cli_ask
+from .providers import (
+    ALIASES,
+    LLMClient,
+    LLMMessage,
+    ProviderConfig,
+    ToolCall,
+    normalize_tool_calls,
+    probe_capabilities,
+    resolve_fallbacks,
+    resolve_model,
+)
+from .scheduler import Job, Scheduler
+from .subagents import (
+    ChildRun,
+    SubagentManager,
+    default_manager,
+    readonly_subset,
+    scoped_registry,
+)
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "Agent",
+    "RunResult",
+    "Event",
+    "EventLog",
+    "list_runs",
+    "replay",
+    "summarize",
+    "Action",
+    "PermissionGate",
+    "cli_ask",
+    "ALIASES",
+    "LLMClient",
+    "LLMMessage",
+    "ProviderConfig",
+    "ToolCall",
+    "normalize_tool_calls",
+    "probe_capabilities",
+    "resolve_fallbacks",
+    "resolve_model",
+    "Job",
+    "Scheduler",
+    "ChildRun",
+    "SubagentManager",
+    "default_manager",
+    "readonly_subset",
+    "scoped_registry",
+]