flowly-ai 0.2.0__tar.gz

flowly_ai-0.2.0/.gitignore

@@ -0,0 +1,18 @@
+.assets
+.env
+*.pyc
+dist/
+build/
+docs/
+*.egg-info/
+*.egg
+*.pyc
+*.pyo
+*.pyd
+*.pyw
+*.pyz
+*.pywz
+*.pyzznanobot/
+nanobot/
+path/
+.DS_Store

flowly_ai-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 nocetic limited
+
+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.

flowly_ai-0.2.0/PKG-INFO

@@ -0,0 +1,397 @@
+Metadata-Version: 2.4
+Name: flowly-ai
+Version: 0.2.0
+Summary: A lightweight personal AI assistant framework
+Project-URL: Homepage, https://github.com/hakansoren/flowlyai
+Project-URL: Repository, https://github.com/hakansoren/flowlyai
+Project-URL: Issues, https://github.com/hakansoren/flowlyai/issues
+Author: flowly contributors
+License: MIT
+License-File: LICENSE
+Keywords: agent,ai,assistant,chatbot,discord,slack,telegram,voice
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.11
+Requires-Dist: aiohttp>=3.9.0
+Requires-Dist: audioop-lts>=0.2.0; python_version >= '3.13'
+Requires-Dist: croniter>=2.0.0
+Requires-Dist: filelock>=3.0.0
+Requires-Dist: httpx>=0.25.0
+Requires-Dist: inquirerpy>=0.3.4
+Requires-Dist: litellm>=1.0.0
+Requires-Dist: loguru>=0.7.0
+Requires-Dist: pydantic-settings>=2.0.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: pyngrok>=7.0.0
+Requires-Dist: python-multipart>=0.0.6
+Requires-Dist: python-telegram-bot>=21.0
+Requires-Dist: readability-lxml>=0.8.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: slack-sdk>=3.26.0
+Requires-Dist: starlette>=0.32.0
+Requires-Dist: tiktoken>=0.5.0
+Requires-Dist: typer>=0.9.0
+Requires-Dist: uvicorn>=0.24.0
+Requires-Dist: websocket-client>=1.6.0
+Requires-Dist: websockets>=12.0
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<div align="center">
+  <img src="flowly_logo.svg" alt="Flowly" width="150">
+  <h1>Flowly AI</h1>
+  <p><strong>Your personal AI that runs locally, talks everywhere.</strong></p>
+  <p>
+    <img src="https://img.shields.io/badge/python-≥3.11-3776AB?logo=python&logoColor=white" alt="Python">
+    <img src="https://img.shields.io/badge/platform-macOS%20·%20Linux%20·%20Windows-lightgrey" alt="Platform">
+    <img src="https://img.shields.io/badge/license-MIT-green" alt="License">
+  </p>
+</div>
+
+---
+
+Flowly is a personal AI assistant that lives on your machine. Connect it to Telegram, WhatsApp, Discord, or Slack — then talk to it from anywhere. It can browse the web, manage files, run shell commands, take screenshots, schedule tasks, make phone calls, and more.
+
+```
+You (Telegram) → Flowly (your Mac/PC) → tools, files, APIs → response
+```
+
+## Why Flowly?
+
+- **Runs on your machine** — your data stays local, your tools stay private
+- **Always on** — install as a background service, survives terminal close and reboot
+- **Multi-channel** — one agent, reachable from Telegram, WhatsApp, Discord, Slack
+- **Voice calls** — answer phone calls with Twilio, talk with real-time STT/TTS
+- **Extensible** — add tools, skills, personas, or entire channel adapters
+- **Cross-platform** — macOS (launchd), Linux (systemd), Windows (Task Scheduler)
+
+## Quick Start
+
+**Install with [uv](https://github.com/astral-sh/uv)** (recommended)
+
+```bash
+uv tool install flowly-ai
+```
+
+**Install from PyPI**
+
+```bash
+pip install flowly-ai
+```
+
+**Install from source** (development)
+
+```bash
+git clone https://github.com/hakansoren/flowlyai.git && cd flowlyai
+pip install -e .
+```
+
+Then:
+
+```bash
+flowly onboard                      # First-time setup
+flowly agent -m "What can you do?"  # Chat
+```
+
+> **API keys:** Set your [OpenRouter](https://openrouter.ai/keys) key in `~/.flowly/config.json`. Optional: [Groq](https://console.groq.com/keys) (voice), [Brave Search](https://brave.com/search/api/) (web search).
+
+## Architecture
+
+```
+┌─────────────────────────────────────────────┐
+│                  Gateway                     │
+│                                              │
+│  ┌──────────┐  ┌──────────┐  ┌───────────┐  │
+│  │ Telegram │  │ WhatsApp │  │  Discord   │  │
+│  │  Slack   │  │  Voice   │  │   CLI      │  │
+│  └────┬─────┘  └────┬─────┘  └─────┬─────┘  │
+│       └──────────────┼──────────────┘        │
+│                      ▼                       │
+│              ┌──────────────┐                │
+│              │  Agent Loop  │                │
+│              │   (LiteLLM)  │                │
+│              └──────┬───────┘                │
+│                     ▼                        │
+│  ┌─────┐ ┌──────┐ ┌─────┐ ┌──────┐ ┌─────┐ │
+│  │Shell│ │ Web  │ │File │ │ Cron │ │ ... │ │
+│  └─────┘ └──────┘ └─────┘ └──────┘ └─────┘ │
+│                                              │
+│  ┌──────────────────────────────────────┐    │
+│  │  Skills · Personas · Hub · Memory    │    │
+│  └──────────────────────────────────────┘    │
+└─────────────────────────────────────────────┘
+```
+
+## Built-in Tools
+
+| Tool | What it does |
+|------|-------------|
+| **Shell** | Run commands on your machine |
+| **Filesystem** | Read, write, edit, list files |
+| **Web** | Fetch URLs, search with Brave |
+| **Screenshot** | Capture your screen |
+| **Cron** | Schedule recurring tasks |
+| **Docker** | Manage containers and images |
+| **Trello** | Create/manage boards and cards |
+| **System** | CPU, memory, disk, process info |
+| **Voice** | Make and receive phone calls |
+| **Spawn** | Run background sub-agents |
+
+## Channels
+
+Connect Flowly to your favorite chat apps. Each channel runs simultaneously through the gateway.
+
+<details>
+<summary><b>Telegram</b> — easiest setup</summary>
+
+1. Create a bot via `@BotFather` on Telegram
+2. Add to config:
+
+```json
+{
+  "channels": {
+    "telegram": {
+      "enabled": true,
+      "token": "YOUR_BOT_TOKEN",
+      "allowFrom": ["YOUR_USER_ID"]
+    }
+  }
+}
+```
+
+3. `uv run flowly gateway`
+
+> Get your user ID from `@userinfobot`.
+
+</details>
+
+<details>
+<summary><b>WhatsApp</b> — scan QR</summary>
+
+```bash
+uv run flowly channels login    # Scan QR code
+uv run flowly gateway           # Start (in another terminal)
+```
+
+```json
+{
+  "channels": {
+    "whatsapp": {
+      "enabled": true,
+      "allowFrom": ["+1234567890"]
+    }
+  }
+}
+```
+
+Requires Node.js ≥18.
+
+</details>
+
+<details>
+<summary><b>Discord</b></summary>
+
+```json
+{
+  "channels": {
+    "discord": {
+      "enabled": true,
+      "token": "YOUR_BOT_TOKEN",
+      "allowFrom": ["YOUR_USER_ID"]
+    }
+  }
+}
+```
+
+</details>
+
+<details>
+<summary><b>Slack</b></summary>
+
+```json
+{
+  "channels": {
+    "slack": {
+      "enabled": true,
+      "botToken": "xoxb-...",
+      "appToken": "xapp-...",
+      "allowFrom": ["U1234567890"]
+    }
+  }
+}
+```
+
+</details>
+
+## Background Service
+
+Run Flowly as a persistent service — survives terminal close and auto-starts on boot:
+
+```bash
+flowly service install --start    # Install and start
+flowly service status             # Health check
+flowly service logs -f            # Follow logs
+flowly service restart            # Restart
+flowly service stop               # Stop
+flowly service uninstall          # Remove
+```
+
+| Platform | Backend |
+|----------|---------|
+| macOS | launchd (LaunchAgents) |
+| Linux | systemd (user service) |
+| Windows | Task Scheduler |
+
+## Personas
+
+Switch how Flowly talks without changing functionality:
+
+```bash
+flowly persona list              # See all
+flowly persona set jarvis        # Switch persona
+flowly service restart           # Apply
+```
+
+| Persona | Style |
+|---------|-------|
+| `default` | Helpful and friendly |
+| `jarvis` | J.A.R.V.I.S. — British AI, dry wit |
+| `friday` | F.R.I.D.A.Y. — warm, professional |
+| `pirate` | "Aye aye, Captain!" |
+| `samurai` | Brief and wise |
+| `casual` | Your best buddy |
+| `professor` | Step-by-step explanations |
+| `butler` | Distinguished, ultra-polite |
+
+Create your own: drop a `.md` file in `~/.flowly/workspace/personas/`.
+
+## Voice Calls
+
+Flowly can answer and make phone calls with real-time speech:
+
+```bash
+flowly setup voice-calls         # Configure Twilio + STT/TTS
+flowly gateway                   # Start with voice enabled
+```
+
+**Supported providers:**
+- **STT:** Groq Whisper, Deepgram, ElevenLabs
+- **TTS:** ElevenLabs, Deepgram, OpenAI
+- **Telephony:** Twilio
+
+## CLI Reference
+
+```
+flowly onboard                   Initialize config & workspace
+flowly agent -m "..."            Send a message
+flowly agent                     Interactive chat
+flowly gateway                   Start the gateway (all channels)
+flowly gateway --persona jarvis  Start with a persona
+flowly service install --start   Install background service
+flowly service status            Service health check
+flowly service logs -f           Follow logs
+flowly persona list              List personas
+flowly persona set <name>        Switch persona
+flowly setup voice-calls         Configure voice
+flowly channels login            Link WhatsApp
+flowly channels status           Channel status
+flowly status                    Overall status
+```
+
+## Configuration
+
+All config lives in `~/.flowly/config.json`:
+
+```json
+{
+  "providers": {
+    "openrouter": { "apiKey": "sk-or-v1-..." }
+  },
+  "agents": {
+    "defaults": { "model": "anthropic/claude-sonnet-4-5" }
+  },
+  "channels": {
+    "telegram": { "enabled": true, "token": "..." }
+  }
+}
+```
+
+## Requirements
+
+| | Minimum |
+|---|---|
+| **Python** | ≥ 3.11 |
+| **uv** | Any recent version |
+| **Node.js** | ≥ 18 (only for WhatsApp bridge) |
+| **OS** | macOS, Linux, or Windows |
+
+## Desktop App
+
+[Flowly Desktop](https://github.com/hakansoren/flowly-desktop) — Electron app with guided setup, one-click install, and visual management.
+
+---
+
+## Changelog
+
+<details>
+<summary><strong>2026-02-10</strong> — Discord & Slack channels, setup wizard</summary>
+
+- Discord and Slack channel implementations
+- Interactive CLI setup wizard (`flowly setup`)
+- Multi-channel manager support
+
+</details>
+
+<details>
+<summary><strong>2026-02-09</strong> — Service mode, personas, screenshot delegation</summary>
+
+- Background service mode (launchd/systemd/schtasks)
+- 8 built-in personas (Jarvis, Friday, Pirate, etc.)
+- Electron-delegated screenshot system
+- Voice call improvements
+
+</details>
+
+<details>
+<summary><strong>2026-02-06</strong> — Integrated voice system, new tools</summary>
+
+- Twilio voice bridge with real-time audio streaming
+- ElevenLabs, Deepgram, Groq Whisper STT/TTS providers
+- Agentic voice call state machine
+- System monitoring, Docker, Trello integration tools
+- Cross-platform support (Windows/macOS/Linux)
+
+</details>
+
+<details>
+<summary><strong>2026-02-04</strong> — Secure execution, pairing system</summary>
+
+- Secure command execution sandbox
+- Device pairing system
+- Interactive setup CLI wizard
+
+</details>
+
+<details>
+<summary><strong>2026-02-03</strong> — Initial release</summary>
+
+- Core agent loop with LiteLLM provider
+- Telegram and WhatsApp channels
+- Cron scheduling, context compaction
+- Groq Whisper voice transcription
+- Flowly Hub skill management
+
+</details>
+
+---
+
+<p align="center">
+  <sub>MIT License</sub>
+</p>