Metadata-Version: 2.4
Name: yumii
Version: 0.11.0
Summary: Yumii — Open-source, locally-runnable AI companion: a desktop voice orb (Live2D avatar mode coming soon).
Project-URL: Homepage, https://yumii.me
Project-URL: Repository, https://github.com/CodeNeuron58/Yumii
Project-URL: Documentation, https://yumii.me
Project-URL: Bug Tracker, https://github.com/CodeNeuron58/Yumii/issues
License: MIT License
        
        Copyright (c) 2026 Biprayan Choudhuri
        
        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.
License-File: LICENSE
Keywords: ai,anime,companion,langgraph,live2d,llm,voice,whisper
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.12
Requires-Dist: aiohttp>=3.13.5
Requires-Dist: aiosqlite>=0.20.0
Requires-Dist: composio-langchain<0.14,>=0.13
Requires-Dist: composio<0.14,>=0.13
Requires-Dist: ddgs>=9.0.0
Requires-Dist: elevenlabs>=2.38.1
Requires-Dist: fastapi>=0.135.1
Requires-Dist: faster-whisper>=1.2.1
Requires-Dist: groq>=0.28.0
Requires-Dist: kokoro-onnx>=0.5.0
Requires-Dist: langchain-anthropic>=1.4.3
Requires-Dist: langchain-community>=0.3.0
Requires-Dist: langchain-core<2.0,>=1.4
Requires-Dist: langchain-groq>=1.1.2
Requires-Dist: langchain-mcp-adapters>=0.2.0
Requires-Dist: langchain-ollama>=1.1.0
Requires-Dist: langchain-openai>=1.2.1
Requires-Dist: langchain<2.0,>=1.3
Requires-Dist: langgraph-checkpoint-sqlite>=2.0.0
Requires-Dist: langgraph-checkpoint<5.0,>=4.1
Requires-Dist: langgraph-prebuilt<2.0,>=1.1
Requires-Dist: langgraph<2.0,>=1.2
Requires-Dist: numpy>=2.4.2
Requires-Dist: pydantic-settings>=2.14.0
Requires-Dist: pydantic>=2.12.5
Requires-Dist: structlog>=24.1.0
Requires-Dist: uvicorn>=0.41.0
Requires-Dist: vosk>=0.3.45
Requires-Dist: websockets>=16.0
Provides-Extra: dev
Requires-Dist: jupyter>=1.1.1; extra == 'dev'
Requires-Dist: mypy>=1.8.0; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
Requires-Dist: pytest>=8.0.0; extra == 'dev'
Requires-Dist: ruff>=0.3.0; extra == 'dev'
Description-Content-Type: text/markdown

# Yumii 🌸 — An AI Companion for Your Desktop

[![Version](https://img.shields.io/badge/version-0.11.0-orange.svg)](CHANGELOG.md)
[![Python](https://img.shields.io/badge/python-3.12%2B-blue.svg)](https://python.org)
[![uv](https://img.shields.io/badge/package%20manager-uv-green.svg)](https://docs.astral.sh/uv/)
[![FastAPI](https://img.shields.io/badge/FastAPI-backend-009688?logo=fastapi&logoColor=white)](https://fastapi.tiangolo.com)
[![Tauri](https://img.shields.io/badge/desktop-Tauri%20v2-24C8DB.svg)](https://tauri.app/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![GitHub stars](https://img.shields.io/github/stars/CodeNeuron58/Yumii?style=social)](https://github.com/CodeNeuron58/Yumii)

Yumii is an open-source AI companion that lives on your desktop — a floating
orb you talk to, with real-time voice, six personalities, and a memory of
your life together that stays in a file on your machine. Runs on a normal
CPU, no GPU needed.

> ⚠️ **Alpha — no API stability promise yet.** The voice loop, personalities,
> persistent memory (recall of any past conversation, self-written facts,
> session summaries with time sense), and tool-calling behind a
> human-in-the-loop gate all work end-to-end. The animated Live2D avatar is a
> planned "coming soon" mode. See [`CHANGELOG.md`](CHANGELOG.md) and
> [`ROADMAP.md`](ROADMAP.md).

---

## ⚡ Install (one command)

**Windows** (PowerShell):

```powershell
iex (irm https://yumii.me/install.ps1)
```

That's the whole install. It sets up [uv](https://docs.astral.sh/uv/), a
private Python 3.12, Yumii's backend, and the desktop app — then puts
**Yumii in your Start Menu**. Open her, paste one API key in the ⚙️ dashboard
(a free [Groq](https://console.groq.com) key is plenty, or an
[Ollama](https://ollama.com) key), and start talking. Her local voice model
downloads itself the first time she speaks.

**Updating:** re-run the same command.

**macOS / Linux:** the desktop shell is Windows-first for now —
`curl -fsSL https://yumii.me/install.sh | bash` installs the backend for
development, and the native shells are on the roadmap.

---

## ✨ What Yumii Does

- 🎙 **Listens** — Silero VAD + Whisper (local or Groq cloud), with a manual mic mute
- 🧠 **Thinks** — Groq, Ollama Cloud, OpenAI, or Anthropic, with a persistent personality
- 🗣 **Speaks** — Kokoro (fully local, no API key) or ElevenLabs / CAMB.ai, streamed in real time
- 🛠 **Acts** — tools (web search, Gmail/Calendar/Notion via Composio) behind a permission gate
- 🧠 **Remembers** — searches every past conversation (local FTS), writes and corrects her own
  facts, and knows *when* you last spoke and what happened — all in local SQLite
- 🟢 **Reacts** — a floating orb that pulses and shifts colour with the conversation
  (Live2D avatar mode coming soon)
- 🔐 **Private by architecture** — no account, no server, nothing phones home; API keys
  live in an owner-only local file, memory lives in `~/.yumii/`

---

## 🛠 Run From Source (developers)

Needs [uv](https://docs.astral.sh/uv/), Rust + MSVC C++ Build Tools (Windows);
WebView2 ships with Win 10/11.

```bash
git clone https://github.com/CodeNeuron58/Yumii.git
cd Yumii
uv sync

cd desktop && npx @tauri-apps/cli dev   # the desktop app — the only way to run Yumii
```

The shell starts the backend for you (`yumii server` is the headless
launcher it invokes — there is no interactive CLI and no browser UI).

> ⚠️ Use `uv`, **not** `pip` — dependencies are locked with uv and installed
> via `uv sync`.

---

## 🤖 Providers

| Role | Options |
|------|---------|
| **Mind (LLM)** | Groq *(free tier)* · **Ollama Cloud** (minimax-m3, 1M context) · OpenAI · Anthropic |
| **Ears (STT)** | Local Whisper *(private, offline)* · Groq Whisper *(fast, cloud)* · Vosk *(offline streaming)* |
| **Voice (TTS)** | **Kokoro** *(local, free, recommended)* · ElevenLabs · CAMB.ai |

Everything is switchable from the in-app ⚙️ dashboard.

---

## 🏗 Architecture

```mermaid
flowchart TD
    mic["🎙 Microphone"] --> vad["Silero VAD<br/>speech detection"]
    vad --> stt["Whisper STT<br/>local CPU · or Groq cloud"]
    stt --> agent

    subgraph agent [LangGraph Agent]
        direction TB
        sys["System prompt<br/>personality + episodic context + facts"] --> llm["LLM invoke<br/>Groq · Ollama · OpenAI · Anthropic<br/>tools bound · HITL-gated"]
        llm --> synth["Synthesizer<br/>response + expression"]
    end

    agent <--> mem[("SQLite memory<br/>sessions · facts · transcript+FTS ·<br/>summaries · checkpoints — ~/.yumii")]
    agent --> tts["TTS<br/>Kokoro local · ElevenLabs · CAMB.ai"]
    tts --> ws["WebSocket"]
    ws --> orb["Desktop orb (Tauri)<br/>pulse + emotion colour"]
    orb -.->|coming soon| live2d["Live2D avatar mode"]
```

---

## 📁 Project Structure

```
src/yumii/
  agent/          # LangGraph state machine, tool-bound LLM, personality manager,
                  # emotion synthesizer, fact extraction + memory review
  api/            # FastAPI server: /health, /ws, REST, /dashboard.html
  audio/          # STT pipeline (Silero VAD + Whisper/Groq/Vosk)
  core/           # settings, auth.json credential store, engine orchestrator,
                  # SQLite memory (facts, transcript+FTS, session summaries)
  tts/            # Kokoro (local ONNX) + ElevenLabs + CAMB.ai streaming
  tools/          # tool registry + policies: web search, recall, memory,
                  # Composio integrations
  assets/         # personality prompts, orb + dashboard pages, Silero model
  cli.py          # bare launcher: `yumii server` (the shell invokes this)

desktop/
  src-tauri/      # Tauri v2 shell: orb window, tray, global hotkey,
                  # backend launcher
```

> **Memory** lives at `~/.yumii/memory/` (auto-created). **API keys** at
> `~/.yumii/auth.json`.

---

## 🔐 Security

- **`~/.yumii/auth.json`** — API keys, owner-only permissions, atomic writes
  (the same storage model Claude Code and opencode use).
- **`~/.yumii/config.json`** — non-sensitive preferences.
- No accounts, no telemetry, no server of ours: your data goes only to the
  LLM/STT/TTS providers *you* configure — or stays fully on-device with the
  local options.

---

## 🤝 Contributing

Contributions are welcome! See [CONTRIBUTING.md](CONTRIBUTING.md).

Ideas: new personality prompts, more tools, TTS backends, the Live2D avatar
mode, macOS/Linux desktop shells.

---

## 📄 License

MIT — see [LICENSE](LICENSE).
