openfish 1.0.0__tar.gz

openfish-1.0.0/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: openfish
+Version: 1.0.0
+Summary: OpenFish: single-user Telegram-driven personal Codex assistant
+Author: Re13orn
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Re13orn/openfish
+Project-URL: Repository, https://github.com/Re13orn/openfish
+Project-URL: Issues, https://github.com/Re13orn/openfish/issues
+Project-URL: Changelog, https://github.com/Re13orn/openfish/blob/main/CHANGELOG.md
+Keywords: telegram,codex,assistant,cli,self-hosted
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Communications :: Chat
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: python-telegram-bot>=22.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+
+OpenFish
+========
+
+OpenFish is a single-user, Telegram-driven local Codex assistant.
+
+It lets one trusted owner control local repositories from Telegram while execution, approvals, state, and audit data remain on the local machine.
+
+Core capabilities
+-----------------
+
+- Project lifecycle: list, select, add, disable, archive
+- Task lifecycle: ask, do, resume, retry, cancel
+- Scheduling: periodic task add/list/run/pause/enable/delete
+- Approval flow: approve/reject continuation
+- Project memory: notes, recent summaries, paginated memory view
+- Codex session browser: OpenFish sessions and local native sessions
+- MCP management: list, inspect, enable, disable
+- Service controls: restart, logs, update-check, self-update
+- CLI runtime: `openfish install`, `configure`, `check`, `start`
+
+Quick start
+-----------
+
+Install:
+
+```bash
+pip install openfish
+```
+
+Repository mode:
+
+```bash
+openfish install
+openfish configure
+openfish check
+openfish start
+```
+
+Home runtime mode:
+
+```bash
+openfish init-home
+export OPENFISH_HOME=~/.config/openfish
+openfish install
+openfish configure
+openfish check
+openfish start
+```
+
+Common commands
+---------------
+
+- `openfish install`
+- `openfish uninstall`
+- `openfish configure`
+- `openfish init-home`
+- `openfish check`
+- `openfish start`
+- `openfish stop`
+- `openfish restart`
+- `openfish status`
+- `openfish logs`
+- `openfish update-check`
+
+Scope
+-----
+
+OpenFish is built for:
+
+- one trusted owner
+- local-first execution
+- project-scoped continuity
+- Telegram as the primary control surface
+
+OpenFish is not:
+
+- a multi-user bot platform
+- a public remote shell
+- a cloud orchestration system
+
+Links
+-----
+
+- Homepage: https://github.com/Re13orn/openfish
+- README: https://github.com/Re13orn/openfish/blob/main/README.md
+- 中文说明: https://github.com/Re13orn/openfish/blob/main/README_CN.md
+- Security: https://github.com/Re13orn/openfish/blob/main/SECURITY.md
+- Changelog: https://github.com/Re13orn/openfish/blob/main/CHANGELOG.md

openfish-1.0.0/README_PYPI.md

@@ -0,0 +1,88 @@
+OpenFish
+========
+
+OpenFish is a single-user, Telegram-driven local Codex assistant.
+
+It lets one trusted owner control local repositories from Telegram while execution, approvals, state, and audit data remain on the local machine.
+
+Core capabilities
+-----------------
+
+- Project lifecycle: list, select, add, disable, archive
+- Task lifecycle: ask, do, resume, retry, cancel
+- Scheduling: periodic task add/list/run/pause/enable/delete
+- Approval flow: approve/reject continuation
+- Project memory: notes, recent summaries, paginated memory view
+- Codex session browser: OpenFish sessions and local native sessions
+- MCP management: list, inspect, enable, disable
+- Service controls: restart, logs, update-check, self-update
+- CLI runtime: `openfish install`, `configure`, `check`, `start`
+
+Quick start
+-----------
+
+Install:
+
+```bash
+pip install openfish
+```
+
+Repository mode:
+
+```bash
+openfish install
+openfish configure
+openfish check
+openfish start
+```
+
+Home runtime mode:
+
+```bash
+openfish init-home
+export OPENFISH_HOME=~/.config/openfish
+openfish install
+openfish configure
+openfish check
+openfish start
+```
+
+Common commands
+---------------
+
+- `openfish install`
+- `openfish uninstall`
+- `openfish configure`
+- `openfish init-home`
+- `openfish check`
+- `openfish start`
+- `openfish stop`
+- `openfish restart`
+- `openfish status`
+- `openfish logs`
+- `openfish update-check`
+
+Scope
+-----
+
+OpenFish is built for:
+
+- one trusted owner
+- local-first execution
+- project-scoped continuity
+- Telegram as the primary control surface
+
+OpenFish is not:
+
+- a multi-user bot platform
+- a public remote shell
+- a cloud orchestration system
+
+Links
+-----
+
+- Homepage: https://github.com/Re13orn/openfish
+- README: https://github.com/Re13orn/openfish/blob/main/README.md
+- 中文说明: https://github.com/Re13orn/openfish/blob/main/README_CN.md
+- Security: https://github.com/Re13orn/openfish/blob/main/SECURITY.md
+- Changelog: https://github.com/Re13orn/openfish/blob/main/CHANGELOG.md

openfish-1.0.0/openfish.egg-info/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: openfish
+Version: 1.0.0
+Summary: OpenFish: single-user Telegram-driven personal Codex assistant
+Author: Re13orn
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Re13orn/openfish
+Project-URL: Repository, https://github.com/Re13orn/openfish
+Project-URL: Issues, https://github.com/Re13orn/openfish/issues
+Project-URL: Changelog, https://github.com/Re13orn/openfish/blob/main/CHANGELOG.md
+Keywords: telegram,codex,assistant,cli,self-hosted
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Communications :: Chat
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: python-telegram-bot>=22.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+
+OpenFish
+========
+
+OpenFish is a single-user, Telegram-driven local Codex assistant.
+
+It lets one trusted owner control local repositories from Telegram while execution, approvals, state, and audit data remain on the local machine.
+
+Core capabilities
+-----------------
+
+- Project lifecycle: list, select, add, disable, archive
+- Task lifecycle: ask, do, resume, retry, cancel
+- Scheduling: periodic task add/list/run/pause/enable/delete
+- Approval flow: approve/reject continuation
+- Project memory: notes, recent summaries, paginated memory view
+- Codex session browser: OpenFish sessions and local native sessions
+- MCP management: list, inspect, enable, disable
+- Service controls: restart, logs, update-check, self-update
+- CLI runtime: `openfish install`, `configure`, `check`, `start`
+
+Quick start
+-----------
+
+Install:
+
+```bash
+pip install openfish
+```
+
+Repository mode:
+
+```bash
+openfish install
+openfish configure
+openfish check
+openfish start
+```
+
+Home runtime mode:
+
+```bash
+openfish init-home
+export OPENFISH_HOME=~/.config/openfish
+openfish install
+openfish configure
+openfish check
+openfish start
+```
+
+Common commands
+---------------
+
+- `openfish install`
+- `openfish uninstall`
+- `openfish configure`
+- `openfish init-home`
+- `openfish check`
+- `openfish start`
+- `openfish stop`
+- `openfish restart`
+- `openfish status`
+- `openfish logs`
+- `openfish update-check`
+
+Scope
+-----
+
+OpenFish is built for:
+
+- one trusted owner
+- local-first execution
+- project-scoped continuity
+- Telegram as the primary control surface
+
+OpenFish is not:
+
+- a multi-user bot platform
+- a public remote shell
+- a cloud orchestration system
+
+Links
+-----
+
+- Homepage: https://github.com/Re13orn/openfish
+- README: https://github.com/Re13orn/openfish/blob/main/README.md
+- 中文说明: https://github.com/Re13orn/openfish/blob/main/README_CN.md
+- Security: https://github.com/Re13orn/openfish/blob/main/SECURITY.md
+- Changelog: https://github.com/Re13orn/openfish/blob/main/CHANGELOG.md

openfish-1.0.0/openfish.egg-info/SOURCES.txt

@@ -0,0 +1,88 @@
+README_PYPI.md
+pyproject.toml
+openfish.egg-info/PKG-INFO
+openfish.egg-info/SOURCES.txt
+openfish.egg-info/dependency_links.txt
+openfish.egg-info/entry_points.txt
+openfish.egg-info/requires.txt
+openfish.egg-info/top_level.txt
+src/__init__.py
+src/app.py
+src/approval.py
+src/approval_store.py
+src/audit.py
+src/audit_events.py
+src/auth.py
+src/chat_state_store.py
+src/cli.py
+src/codex_runner.py
+src/codex_session_service.py
+src/config.py
+src/db.py
+src/event_consistency.py
+src/formatters.py
+src/github_repo_service.py
+src/main.py
+src/mcp_service.py
+src/models.py
+src/process_lock.py
+src/progress_reporter.py
+src/project_registry.py
+src/project_state_store.py
+src/redaction.py
+src/repo_inspector.py
+src/router.py
+src/schedule_store.py
+src/scheduler.py
+src/security_guard.py
+src/skills_service.py
+src/system_notification_store.py
+src/task_runtime_store.py
+src/task_store.py
+src/telegram_adapter.py
+src/telegram_messages.py
+src/telegram_sink.py
+src/telegram_views.py
+src/update_service.py
+src/resources/env.example
+src/resources/schema.sql
+src/resources/migrations/0002_chat_context.sql
+src/resources/migrations/0003_scheduled_tasks.sql
+src/resources/migrations/0004_chat_flows_and_recent_projects.sql
+src/resources/migrations/0005_chat_ui_mode.sql
+src/resources/migrations/0006_chat_delivery_state.sql
+src/resources/migrations/0007_chat_codex_model.sql
+src/resources/migrations/0008_system_notifications.sql
+tests/test_approval.py
+tests/test_approval_store.py
+tests/test_audit.py
+tests/test_cards_snapshot.py
+tests/test_chat_state_store.py
+tests/test_cli.py
+tests/test_codex_runner.py
+tests/test_config.py
+tests/test_db.py
+tests/test_event_consistency.py
+tests/test_formatters.py
+tests/test_github_repo_service.py
+tests/test_mcp_service.py
+tests/test_process_lock.py
+tests/test_progress_reporter.py
+tests/test_project_registry.py
+tests/test_project_state_store.py
+tests/test_redaction.py
+tests/test_router.py
+tests/test_schedule_store.py
+tests/test_scheduler.py
+tests/test_security_guard.py
+tests/test_skills_service.py
+tests/test_system_notification_store.py
+tests/test_task_events.py
+tests/test_task_runtime_store.py
+tests/test_task_store_context.py
+tests/test_task_store_schedule.py
+tests/test_telegram_adapter.py
+tests/test_telegram_messages.py
+tests/test_telegram_sink.py
+tests/test_telegram_views.py
+tests/test_update_service.py

openfish-1.0.0/openfish.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

openfish-1.0.0/openfish.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+openfish = src.cli:main

openfish-1.0.0/openfish.egg-info/requires.txt

@@ -0,0 +1,5 @@
+PyYAML>=6.0
+python-telegram-bot>=22.0
+
+[dev]
+pytest>=8.0

openfish-1.0.0/openfish.egg-info/top_level.txt

@@ -0,0 +1 @@
+src

openfish-1.0.0/pyproject.toml

@@ -0,0 +1,58 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "openfish"
+version = "1.0.0"
+description = "OpenFish: single-user Telegram-driven personal Codex assistant"
+readme = "README_PYPI.md"
+requires-python = ">=3.12"
+license = "MIT"
+authors = [
+  { name = "Re13orn" },
+]
+keywords = ["telegram", "codex", "assistant", "cli", "self-hosted"]
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Environment :: Console",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Communications :: Chat",
+  "Topic :: Software Development :: Build Tools",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+  "PyYAML>=6.0",
+  "python-telegram-bot>=22.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/Re13orn/openfish"
+Repository = "https://github.com/Re13orn/openfish"
+Issues = "https://github.com/Re13orn/openfish/issues"
+Changelog = "https://github.com/Re13orn/openfish/blob/main/CHANGELOG.md"
+
+[project.scripts]
+openfish = "src.cli:main"
+
+[project.optional-dependencies]
+dev = [
+  "pytest>=8.0",
+]
+
+[tool.setuptools]
+packages = ["src"]
+include-package-data = true
+
+[tool.setuptools.package-data]
+src = [
+  "resources/schema.sql",
+  "resources/env.example",
+  "resources/migrations/*.sql",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

openfish-1.0.0/setup.cfg

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

openfish-1.0.0/src/__init__.py

@@ -0,0 +1 @@
+"""OpenFish assistant package."""

openfish-1.0.0/src/app.py

@@ -0,0 +1,136 @@
+"""Application composition root."""
+
+import logging
+from pathlib import Path
+
+from src.audit import AuditLogger
+from src.approval import ApprovalService
+from src.codex_runner import CodexRunner
+from src.codex_session_service import CodexSessionService
+from src.config import AppConfig, load_config
+from src.db import Database
+from src.github_repo_service import GitHubRepoService
+from src.project_registry import ProjectRegistry
+from src.process_lock import ProcessLock, acquire_process_lock
+from src.repo_inspector import RepoInspector
+from src.router import CommandRouter
+from src.scheduler import ScheduledTaskService
+from src.skills_service import SkillsService
+from src.mcp_service import McpService
+from src.task_store import TaskStore
+from src.telegram_adapter import TelegramBotService
+from src.update_service import UpdateService
+
+
+logger = logging.getLogger(__name__)
+
+
+class Application:
+    """Build and run the single-process assistant service."""
+
+    def __init__(self, config: AppConfig) -> None:
+        self.config = config
+        self.process_lock: ProcessLock | None = None
+        self.db = Database(config.sqlite_path, config.schema_path, config.migrations_dir)
+        self.projects = ProjectRegistry(config.projects_config_path)
+        self.tasks = TaskStore(self.db)
+        self.audit = AuditLogger(self.db)
+        self.approvals = ApprovalService()
+        self.codex = CodexRunner(config)
+        self.codex_sessions = CodexSessionService(db=self.db, codex_home=config.codex_home)
+        self.skills = SkillsService(
+            codex_bin=config.codex_bin,
+            skills_root=config.codex_home / "skills",
+            enable_install=config.enable_skill_install,
+            timeout_seconds=config.skill_install_timeout_seconds,
+        )
+        self.mcp = McpService(
+            codex_bin=config.codex_bin,
+            timeout_seconds=config.codex_command_timeout_seconds,
+            config_path=config.codex_home / "config.toml",
+        )
+        self.updates = UpdateService(
+            repo_root=Path(__file__).resolve().parents[2],
+            script_path=Path(__file__).resolve().parents[1] / "scripts" / "install_start.sh",
+        )
+        self.github_repos = GitHubRepoService()
+        self.repo = RepoInspector()
+        self.router = CommandRouter(
+            config=config,
+            projects=self.projects,
+            tasks=self.tasks,
+            audit=self.audit,
+            codex=self.codex,
+            repo=self.repo,
+            approvals=self.approvals,
+            skills_service=self.skills,
+            mcp_service=self.mcp,
+            update_service=self.updates,
+            codex_sessions=self.codex_sessions,
+            github_repos=self.github_repos,
+        )
+        self.scheduler = ScheduledTaskService(
+            tasks=self.tasks,
+            router=self.router,
+            poll_interval_seconds=self.config.schedule_poll_interval_seconds,
+            enabled=self.config.enable_scheduler,
+            missed_run_policy=self.config.schedule_missed_run_policy,
+        )
+        self.bot = TelegramBotService(config=config, router=self.router)
+
+    def run(self) -> None:
+        self._configure_logging()
+        self.process_lock = acquire_process_lock(self.config.process_lock_path)
+        logger.info("Acquired process lock: %s", self.config.process_lock_path)
+        self.projects.load()
+        self._run_startup_health_checks()
+        self.db.connect()
+        self.db.initialize_schema()
+        self.tasks.sync_projects_from_registry(self.projects)
+        recovered_task_ids = self.tasks.recover_interrupted_tasks()
+        if recovered_task_ids:
+            logger.warning(
+                "Recovered %d interrupted task(s) on startup: %s",
+                len(recovered_task_ids),
+                ", ".join(str(task_id) for task_id in recovered_task_ids),
+            )
+        self.scheduler.start()
+        try:
+            self.bot.run_polling()
+        finally:
+            self.scheduler.stop()
+            self.db.close_all()
+            if self.process_lock is not None:
+                self.process_lock.release()
+                self.process_lock = None
+
+    def _configure_logging(self) -> None:
+        logging.basicConfig(
+            level=getattr(logging, self.config.log_level.upper(), logging.INFO),
+            format="%(asctime)s %(levelname)s %(name)s: %(message)s",
+        )
+
+    def _run_startup_health_checks(self) -> None:
+        if not self.projects.projects:
+            logger.warning(
+                "Project registry is empty. Service will start, but you should add a project via /project-add."
+            )
+            return
+
+        for key, project in self.projects.projects.items():
+            if not project.is_active:
+                continue
+            if not self.projects.is_path_allowed(project, project.path):
+                raise ValueError(
+                    f"Project '{key}' path is not in allowed_directories: {project.path}"
+                )
+            project_path = Path(project.path)
+            if not project_path.exists():
+                logger.warning("Project path does not exist for key=%s path=%s", key, project_path)
+
+
+def create_app() -> Application:
+    """Factory used by CLI entry points and tests."""
+
+    config = load_config()
+    return Application(config)

openfish-1.0.0/src/approval.py

@@ -0,0 +1,57 @@
+"""Approval policy helpers for Phase 3 workflow."""
+
+from dataclasses import dataclass
+import re
+
+from src.codex_runner import CodexRunResult
+
+
+APPROVAL_PATTERNS = [
+    re.compile(r"\bneeds?\s+approval\b", re.IGNORECASE),
+    re.compile(r"\bwaiting\s+for\s+approval\b", re.IGNORECASE),
+    re.compile(r"\brequires?\s+approval\b", re.IGNORECASE),
+    re.compile(r"\bapprove\b", re.IGNORECASE),
+    re.compile(r"等待审批"),
+    re.compile(r"需要审批"),
+    re.compile(r"请批准"),
+]
+
+
+@dataclass(slots=True)
+class ApprovalAssessment:
+    requires_approval: bool
+    reason: str | None
+
+
+class ApprovalService:
+    """Detects approval pauses from Codex output and builds follow-up instructions."""
+
+    def assess(self, result: CodexRunResult) -> ApprovalAssessment:
+        text_parts = [result.summary or "", result.stderr or "", result.stdout or ""]
+        combined = "\n".join(part for part in text_parts if part).strip()
+        if not combined:
+            return ApprovalAssessment(requires_approval=False, reason=None)
+
+        for pattern in APPROVAL_PATTERNS:
+            if pattern.search(combined):
+                reason = self._extract_reason(combined)
+                return ApprovalAssessment(requires_approval=True, reason=reason)
+        return ApprovalAssessment(requires_approval=False, reason=None)
+
+    def build_resume_instruction(self, requested_action: str, user_note: str | None = None) -> str:
+        base = (
+            "Approval granted. Continue the previously blocked task with conservative changes and concise summary. "
+            f"Approved action context: {requested_action}"
+        )
+        if user_note:
+            return f"{base}\nUser note: {user_note}"
+        return base
+
+    def _extract_reason(self, text: str, max_len: int = 240) -> str:
+        for line in text.splitlines():
+            candidate = line.strip()
+            if not candidate:
+                continue
+            if any(p.search(candidate) for p in APPROVAL_PATTERNS):
+                return candidate[:max_len]
+        return text[:max_len]