ene-agent 0.1.0__tar.gz

ene_agent-0.1.0/LICENSE

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

ene_agent-0.1.0/PKG-INFO

@@ -0,0 +1,90 @@
+Metadata-Version: 2.4
+Name: ene-agent
+Version: 0.1.0
+Summary: Terminal-based AI coding agent with reusable skills, personas, and a Web UI
+Author: ashawkey
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/ashawkey/ene
+Project-URL: Repository, https://github.com/ashawkey/ene
+Project-URL: Issues, https://github.com/ashawkey/ene/issues
+Project-URL: Documentation, https://ashawkey.github.io/ene/
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: beautifulsoup4
+Requires-Dist: ddgs
+Requires-Dist: fastapi
+Requires-Dist: filelock
+Requires-Dist: httpcore
+Requires-Dist: httpx[socks]
+Requires-Dist: markdown-it-py
+Requires-Dist: openai
+Requires-Dist: pathspec
+Requires-Dist: prompt-toolkit
+Requires-Dist: pygments
+Requires-Dist: pyyaml
+Requires-Dist: questionary
+Requires-Dist: rich
+Requires-Dist: starlette
+Requires-Dist: uvicorn
+Requires-Dist: websockets
+Dynamic: license-file
+
+<p align="center">
+    <picture>
+    <img alt="logo" src="docs/public/favicon.svg" width="10%">
+    </picture>
+    </br>
+    <b>Ene</b>
+    </br>
+    <code>pip install ene-agent</code>
+    &nbsp;&nbsp;&bull;&nbsp;&nbsp;
+    <a href="https://ene.kiui.moe/">Documentation</a>
+</p>
+
+An experimental agent harness for personal use.  
+It's as powerful as other modern agents, but also pythonic and educational for you to understand what happens behind each tool/skill.
+
+## Features
+
+- **Nothing is Unknown**: Explicit context and system prompt, no unexpected memory: You know the agent.
+- **Skill-first Design**: Hierarhical skill loading makes the core small, but capacity large. Memory is also skill.
+- **Optimized Bundled Skills**: Plan, review, clean up, create skills, background processes, pdf-reading, ... 
+- **Personal Skill Library**: Use a github repository to easily synchronize your skills.
+- **Terminal-Native & Web UI**: Native terminal experience, while also attached to a modern web UI.
+
+## Quick Start
+
+```bash
+pip install ene-agent
+
+# or from github source
+pip install git+https://github.com/ashawkey/ene.git
+```
+
+Configure a model in `~/.ene.yaml`, then start chatting:
+
+```yaml
+openai: # openai-compatible
+  deepseek: # model alias
+    model: deepseek-v4-pro # model name
+    base_url: https://api.deepseek.com # base URL
+    api_key: ... # your API key
+```
+
+It also supports codex subscription login, please check the documentation for details.
+
+```bash
+ene # start the terminal UI to chat
+ene --resume # resume a previous session
+
+ene list # list available modelss
+ene status # check the status of the .ene folder
+ene clean # remove disposable data such as tool results and scratch files
+ene clean --history # also remove saved conversation sessions
+ene hub # start web UI hub (need to run in background)
+ene update # update to the latest source code from github
+ene lib # skill library management
+```
+
+WARNING: it has the same permission as the shell user and NO safety guard, use at your own risk.

ene_agent-0.1.0/README.md

@@ -0,0 +1,58 @@
+<p align="center">
+    <picture>
+    <img alt="logo" src="docs/public/favicon.svg" width="10%">
+    </picture>
+    </br>
+    <b>Ene</b>
+    </br>
+    <code>pip install ene-agent</code>
+    &nbsp;&nbsp;&bull;&nbsp;&nbsp;
+    <a href="https://ene.kiui.moe/">Documentation</a>
+</p>
+
+An experimental agent harness for personal use.  
+It's as powerful as other modern agents, but also pythonic and educational for you to understand what happens behind each tool/skill.
+
+## Features
+
+- **Nothing is Unknown**: Explicit context and system prompt, no unexpected memory: You know the agent.
+- **Skill-first Design**: Hierarhical skill loading makes the core small, but capacity large. Memory is also skill.
+- **Optimized Bundled Skills**: Plan, review, clean up, create skills, background processes, pdf-reading, ... 
+- **Personal Skill Library**: Use a github repository to easily synchronize your skills.
+- **Terminal-Native & Web UI**: Native terminal experience, while also attached to a modern web UI.
+
+## Quick Start
+
+```bash
+pip install ene-agent
+
+# or from github source
+pip install git+https://github.com/ashawkey/ene.git
+```
+
+Configure a model in `~/.ene.yaml`, then start chatting:
+
+```yaml
+openai: # openai-compatible
+  deepseek: # model alias
+    model: deepseek-v4-pro # model name
+    base_url: https://api.deepseek.com # base URL
+    api_key: ... # your API key
+```
+
+It also supports codex subscription login, please check the documentation for details.
+
+```bash
+ene # start the terminal UI to chat
+ene --resume # resume a previous session
+
+ene list # list available modelss
+ene status # check the status of the .ene folder
+ene clean # remove disposable data such as tool results and scratch files
+ene clean --history # also remove saved conversation sessions
+ene hub # start web UI hub (need to run in background)
+ene update # update to the latest source code from github
+ene lib # skill library management
+```
+
+WARNING: it has the same permission as the shell user and NO safety guard, use at your own risk.

ene_agent-0.1.0/ene/__init__.py

@@ -0,0 +1,5 @@
+"""ene — terminal-based AI agent with tool-use, web access, and shell execution."""
+
+from .api import AgentRunResult, TurnOutcome, run_agent
+
+__all__ = ["AgentRunResult", "TurnOutcome", "run_agent"]

ene_agent-0.1.0/ene/api.py

@@ -0,0 +1,107 @@
+"""Public Python API for one-shot ene agent runs."""
+
+from __future__ import annotations
+
+from contextlib import nullcontext
+from dataclasses import dataclass
+from pathlib import Path
+
+from ene.config import CONFIG_PATH, conf
+from ene.backend import LLMAgent
+from ene.models import ReasoningEffort
+from ene.providers import provider_names
+from ene.ui import AgentConsole
+from ene.utils.interrupt import TurnOutcome
+
+
+@dataclass(frozen=True)
+class AgentRunResult:
+    """Result of a completed :func:`run_agent` invocation."""
+
+    response: str | None
+    outcome: TurnOutcome
+    token_usage: dict[str, int]
+    error: str | None = None
+
+    @property
+    def success(self) -> bool:
+        return self.outcome == TurnOutcome.COMPLETED
+
+
+def run_agent(
+    task: str,
+    *,
+    model_alias: str | None = None,
+    persona: str | None = None,
+    work_dir: str | Path | None = None,
+    reasoning_effort: ReasoningEffort | None = None,
+    stream: bool = False,
+    verbose: bool = False,
+    quiet: bool = True,
+    console: AgentConsole | None = None,
+) -> AgentRunResult:
+    """Run one independent, non-interactive agent task.
+
+    ``model_alias`` selects an entry under ``openai`` in the loaded ene
+    configuration; omitting it selects the first configured model. The run has
+    a fresh conversation, does not create an interactive session or rewind
+    history, and always releases provider, process, and skill resources before
+    returning.
+
+    Progress output is suppressed by default. Pass ``quiet=False`` to observe
+    normal output, optionally through a custom ``console``. Configuration and
+    construction errors are raised; provider failures and interruptions are
+    represented by ``AgentRunResult.outcome``.
+    """
+    if not isinstance(task, str) or not task.strip():
+        raise ValueError("task must be a non-empty string")
+
+    model_configs = conf.get("openai", {})
+    if not isinstance(model_configs, dict) or not model_configs:
+        raise ValueError(f"No models found in config: {CONFIG_PATH}")
+
+    alias = model_alias or next(iter(model_configs))
+    if alias not in model_configs:
+        available = ", ".join(model_configs)
+        raise ValueError(f"Model '{alias}' not found in config. Available: {available}")
+
+    model_conf = model_configs[alias]
+    provider_name = model_conf.get("provider", "openai")
+    if provider_name not in provider_names():
+        available = ", ".join(provider_names())
+        raise ValueError(f"Unknown provider '{provider_name}'. Available: {available}")
+
+    run_console = console or AgentConsole()
+    agent = LLMAgent(
+        model=model_conf.get("model", alias),
+        api_key=model_conf.get("api_key", ""),
+        base_url=model_conf.get("base_url", ""),
+        provider_name=provider_name,
+        model_alias=alias,
+        verbose=verbose,
+        stream=stream,
+        reasoning_effort=reasoning_effort
+        or model_conf.get("reasoning_effort", "high"),
+        context_length=model_conf.get("context_length"),
+        max_output_tokens=model_conf.get("max_output_tokens"),
+        persona=persona,
+        exec_mode=True,
+        work_dir=str(work_dir) if work_dir is not None else None,
+        console=run_console,
+    )
+
+    try:
+        output_context = run_console.suppressed() if quiet else nullcontext()
+        with output_context:
+            response = agent.execute(task)
+        return AgentRunResult(
+            response=response,
+            outcome=agent._last_turn_outcome,
+            token_usage=dict(agent.token_totals),
+            error=agent._last_error,
+        )
+    finally:
+        agent.close()
+
+
+__all__ = ["AgentRunResult", "TurnOutcome", "run_agent"]