mini-swe-agent 1.1.0__py3-none-any.whl

mini_swe_agent-1.1.0.dist-info/METADATA

@@ -0,0 +1,288 @@
+Metadata-Version: 2.4
+Name: mini-swe-agent
+Version: 1.1.0
+Summary: Nano SWE Agent - A simple AI software engineering agent
+Author-email: Kilian Lieret <kilian.lieret@posteo.de>, "Carlos E. Jimenez" <carlosej@princeton.edu>
+License: MIT License
+        
+        Copyright (c) 2025 Kilian A. Lieret and Carlos E. Jimenez
+        
+        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.
+Project-URL: Documentation, https://mini-swe-agent.com/latest/
+Project-URL: Repository, https://github.com/SWE-agent/mini-SWE-agent
+Project-URL: Bug Tracker, https://github.com/SWE-agent/mini-SWE-agent/issues
+Keywords: nlp,agents,code
+Classifier: Development Status :: 3 - Alpha
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: pyyaml
+Requires-Dist: requests
+Requires-Dist: jinja2
+Requires-Dist: litellm
+Requires-Dist: tenacity
+Requires-Dist: rich
+Requires-Dist: python-dotenv
+Requires-Dist: typer
+Requires-Dist: platformdirs
+Requires-Dist: textual
+Requires-Dist: prompt_toolkit
+Provides-Extra: full
+Requires-Dist: mini-swe-agent[dev]; extra == "full"
+Requires-Dist: swe-rex; extra == "full"
+Provides-Extra: dev
+Requires-Dist: datasets; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: pytest-xdist; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: mkdocs-include-markdown-plugin; extra == "dev"
+Requires-Dist: mkdocstrings[python]>=0.18; extra == "dev"
+Requires-Dist: mike; extra == "dev"
+Requires-Dist: mkdocs-material; extra == "dev"
+Requires-Dist: mkdocs-glightbox; extra == "dev"
+Dynamic: license-file
+
+<div align="center">
+
+<a href="https://mini-swe-agent.com/latest/"><img src="https://github.com/SWE-agent/mini-swe-agent/raw/main/docs/assets/mini-swe-agent-banner.svg" alt="mini-swe-agent banner" style="height: 7em"/></a>
+
+<h1>The 100 line AI agent that solves GitHub issues & more</h1>
+
+[![Docs](https://img.shields.io/badge/Docs-green?style=for-the-badge&logo=materialformkdocs&logoColor=white)](https://mini-swe-agent.com/latest/)
+[![Slack](https://img.shields.io/badge/Slack-4A154B?style=for-the-badge&logo=slack&logoColor=white)](https://join.slack.com/t/swe-bench/shared_invite/zt-36pj9bu5s-o3_yXPZbaH2wVnxnss1EkQ)
+![PyPI - Version](https://img.shields.io/pypi/v/mini-swe-agent?style=for-the-badge&logo=python&logoColor=white&labelColor=black&color=deeppink)
+
+</div>
+
+In 2024, [SWE-bench](https://swebench.com) & [SWE-agent](https://swe-agent.com) helped kickstart the agentic AI for software revolution.
+
+We now ask: **What if SWE-agent was 100x smaller, and still worked nearly as well?**
+
+`mini` is for
+
+- 🧪 **Researchers** who want to **benchmark, fine-tune or RL** without assumptions, bloat, or surprises
+- 🧑‍💻 **Hackers & power users** who like their tools like their scripts: **short, sharp, and readable**
+- 🐳 **Engineers** who want something **trivial to sandbox & to deploy anywhere**
+
+Here's some details:
+
+- **🐜 Minimal**: Just [100 lines of python](https://github.com/SWE-agent/mini-swe-agent/blob/main/src/minisweagent/agents/default.py) (+100 total for [env](https://github.com/SWE-agent/mini-swe-agent/blob/main/src/minisweagent/environments/local.py),
+[model](https://github.com/SWE-agent/mini-swe-agent/blob/main/src/minisweagent/models/litellm_model.py), [script](https://github.com/SWE-agent/mini-swe-agent/blob/main/src/minisweagent/run/hello_world.py)) — no fancy dependencies!
+- **💪 Powerful:** Resolves 65% of GitHub issues in the [SWE-bench verified benchmark](https://www.swebench.com/).
+- **🤗 Friendly:** Comes with **two convenient UIs** that will turn this into your daily dev swiss army knife!
+- **🍀 Environments:** In addition to local envs, you can use **docker**, **podman**, **singularity**, **apptainer**, and more
+- **🧪 Tested:** [![Codecov](https://img.shields.io/codecov/c/github/swe-agent/mini-swe-agent?style=flat-square)](https://codecov.io/gh/SWE-agent/mini-swe-agent)
+- **🎓 Cutting edge:** Built by the Princeton & Stanford team behind [SWE-bench](https://swebench.com) and [SWE-agent](https://swe-agent.com).
+
+<details>
+
+<summary>More motivation (for research)</summary>
+
+[SWE-agent](https://swe-agent.com/latest/) jump-started the development of AI agents in 2024. Back then, we placed a lot of emphasis on tools and special interfaces for the agent.
+However, one year later, as LMs have become more capable, a lot of this is not needed at all to build a useful agent!
+In fact, mini-SWE-agent
+
+- Does not have any tools other than bash — it doesn't even use the tool-calling interface of the LMs.
+  This means that you can run it with literally any model. When running in sandboxed environments you also don't need to to take care
+  of installing a single package — all it needs is bash.
+- Has a completely linear history — every step of the agent just appends to the messages and that's it.
+  So there's no difference between the trajectory and the messages that you pass on to the LM.
+- Executes actions with `subprocess.run` — every action is completely independent (as opposed to keeping a stateful shell session running).
+  This makes it trivial to execute the actions in sandboxes (literally just switch out `subprocess.run` with `docker exec`) and to
+  scale up effortlessly.
+
+This makes it perfect as a baseline system and for a system that puts the language model (rather than
+the agent scaffold) in the middle of our attention.
+
+</details>
+
+<details>
+<summary>More motivation (as a tool)</summary>
+
+Some agents are overfitted research artifacts.
+Others are UI-heavy tools, highly optimized for a specific user experience.
+Both variants are hard to understand.
+
+`mini` strives to be
+
+- **Simple** enough to understand at a glance
+- **Convenient** enough to use in daily workflows
+- **Flexible** to extend
+
+A hackable tool, not a black box.
+
+Unlike other agents (including our own [swe-agent](https://swe-agent.com/latest/)),
+it is radically simpler, because it
+
+- Does not have any tools other than bash — it doesn't even use the tool-calling interface of the LMs.
+- Has a completely linear history — every step of the agent just appends to the messages and that's it.
+- Executes actions with `subprocess.run` — every action is completely independent (as opposed to keeping a stateful shell session running).
+
+</details>
+
+<details>
+<summary>Should I use SWE-agent or mini-SWE-agent?</summary>
+
+You should use [`swe-agent`](https://swe-agent.com/latest/) if
+
+- You need specific tools or want to experiment with different tools
+- You want to experiment with different history processors
+- You want very powerful yaml configuration without touching code
+
+You should use [`mini-swe-agent`](https://mini-swe-agent.com/latest/) if
+
+- You want a quick command line tool that works locally
+- You want an agent with a very simple control flow
+- You want even faster, simpler & more stable sandboxing & benchmark evaluations
+
+What you get with both
+
+- Excellent performance on SWE-Bench
+- A trajectory browser
+
+</details>
+
+<table>
+<tr>
+<td width="50%">
+<a href="https://mini-swe-agent.com/latest/usage/mini/"><strong>Simple UI</strong></a> (<code>mini</code>)
+</td>
+<td>
+<a href="https://mini-swe-agent.com/latest/usage/mini_v/"><strong>Visual UI</strong></a> (<code>mini -v</code>)
+</td>
+</tr>
+<tr>
+<td width="50%">
+
+  ![mini](https://github.com/SWE-agent/swe-agent-media/blob/main/media/mini/gif/mini.gif?raw=true)
+
+</td>
+<td>
+
+  ![miniv](https://github.com/SWE-agent/swe-agent-media/blob/main/media/mini/gif/mini2.gif?raw=true)
+
+</td>
+</tr>
+<tr>
+  <td>
+    <a href="https://mini-swe-agent.com/latest/usage/swebench/"><strong>Batch inference</strong></a>
+  </td>
+  <td>
+    <a href="https://mini-swe-agent.com/latest/usage/inspector/"><strong>Trajectory browser</strong></a>
+  </td>
+<tr>
+<tr>
+
+<td>
+
+![swebench](https://github.com/SWE-agent/swe-agent-media/blob/main/media/mini/gif/swebench.gif?raw=true)
+
+</td>
+
+<td>
+
+![inspector](https://github.com/SWE-agent/swe-agent-media/blob/main/media/mini/gif/inspector.gif?raw=true)
+
+</td>
+
+</tr>
+<td>
+<a href="https://mini-swe-agent.com/latest/advanced/cookbook/"><strong>Python bindings</strong></a>
+</td>
+<td>
+<a href="https://mini-swe-agent.com"><strong>More in the docs</strong></a>
+</td>
+</tr>
+<tr>
+<td>
+
+```python
+agent = DefaultAgent(
+    LitellmModel(model_name=...),
+    LocalEnvironment(),
+)
+agent.run("Write a sudoku game")
+```
+</td>
+<td>
+
+* [Quick start](https://mini-swe-agent.com/latest/quickstart/)
+* [`mini`](https://mini-swe-agent.com/latest/usage/mini/)
+* [FAQ](https://mini-swe-agent.com/latest/faq/)
+* [Configuration](https://mini-swe-agent.com/latest/advanced/configuration/)
+* [Power up](https://mini-swe-agent.com/latest/advanced/cookbook/)
+
+</td>
+</tr>
+</table>
+
+## 🔥 Let's get started!
+
+Install + run in virtual environment
+
+```bash
+pip install pipx && pipx ensurepath && pipx run mini-swe-agent [-v]
+```
+
+Alternative: Install in current environment
+
+```bash
+pip install mini-swe-agent && mini [-v]
+```
+
+Alternative: Install from source
+
+```bash
+git clone https://github.com/SWE-agent/mini-swe-agent.git
+cd mini-swe-agent
+pip install -e .
+mini [-v]
+```
+
+Read more in our [documentation](https://mini-swe-agent.com/latest/):
+
+* [Quick start guide](https://mini-swe-agent.com/latest/quickstart/)
+* More on [`mini`](https://mini-swe-agent.com/latest/usage/mini/) and [`mini -v`](https://mini-swe-agent.com/latest/usage/mini_v/)
+* [Configuration](https://mini-swe-agent.com/latest/advanced/configuration/)
+* [Power up with the cookbook](https://mini-swe-agent.com/latest/advanced/cookbook/)
+* [FAQ](https://mini-swe-agent.com/latest/faq/)
+* [Contribute!](https://mini-swe-agent.com/latest/contributing/)
+
+## 👀 More agentic AI
+
+<div align="center">
+  <a href="https://github.com/SWE-agent/SWE-agent"><img src="https://github.com/SWE-agent/mini-swe-agent/raw/main/docs/assets/sweagent_logo_text_below.svg" alt="SWE-agent" height="120px"></a>
+   &nbsp;&nbsp;
+  <a href="https://github.com/SWE-agent/SWE-ReX"><img src="https://github.com/SWE-agent/mini-swe-agent/raw/main/docs/assets/swerex_logo_text_below.svg" alt="SWE-ReX" height="120px"></a>
+   &nbsp;&nbsp;
+  <a href="https://github.com/SWE-bench/SWE-bench"><img src="https://github.com/SWE-agent/mini-swe-agent/raw/main/docs/assets/swebench_logo_text_below.svg" alt="SWE-bench" height="120px"></a>
+  &nbsp;&nbsp;
+  <a href="https://github.com/SWE-bench/SWE-smith"><img src="https://github.com/SWE-agent/mini-swe-agent/raw/main/docs/assets/swesmith_logo_text_below.svg" alt="SWE-smith" height="120px"></a>
+  &nbsp;&nbsp;
+  <a href="https://github.com/SWE-bench/sb-cli"><img src="https://github.com/SWE-agent/mini-swe-agent/raw/main/docs/assets/sbcli_logo_text_below.svg" alt="sb-cli" height="120px"></a>
+</div>
+

mini_swe_agent-1.1.0.dist-info/RECORD

@@ -0,0 +1,47 @@
+mini_swe_agent-1.1.0.dist-info/licenses/LICENSE.md,sha256=D3luWPkdHAe7LBsdD4vzqDAXw6Xewb3G-uczss0uh1s,1094
+minisweagent/__init__.py,sha256=mpxbbp2xmjcHrIPVQ2UgDdE4Pepb-nPGwSJgLkK1ZOw,1805
+minisweagent/__main__.py,sha256=FIyAOiw--c3FQ2g240FOM1FdL0lk_PxSpixu0pQ7WFo,194
+minisweagent/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+minisweagent/agents/__init__.py,sha256=cpjJLzg1IGxLM-tZpoMJV9S33ye13XtdBO0x7DU_Lrk,48
+minisweagent/agents/default.py,sha256=6TZUfKch6e_7m05BXmjqUjV-k068s6ldg7T6zJBbQW8,5438
+minisweagent/agents/interactive.py,sha256=w2lCVUItq7EMCAnPJu0q7RqzU-ScQCz1HNulGGDG8pE,7146
+minisweagent/agents/interactive_textual.py,sha256=iNDUpHA4fQN5z-SGjHY0VU7ZjpNfoa69Mvu5EPv5IPY,12683
+minisweagent/config/README.md,sha256=qc3_XCmXcwRkSPBdSX5bFCwFYd8XWCD12L8lX370hjQ,355
+minisweagent/config/__init__.py,sha256=UfORdQID1Ek_dduZlybUsIKJjihImkSqNU5tIjpw0hk,694
+minisweagent/config/default.yaml,sha256=AGhcIq6X6n5Fs71ufO3B6CtZ4PS877tCxkPkrWR5Ylg,4497
+minisweagent/config/github_issue.yaml,sha256=evvu3AJ52tXYSdami9_B8zfazOAE2r2XXkzVmScBoKc,4539
+minisweagent/config/local.yaml,sha256=zmju4EUcybXlHOSzj-ZL2Se1803nXsZPk6jgrB9KxYw,4815
+minisweagent/config/local2.tcss,sha256=ThSOtS6JpXxqEYGX69TLy6gPZzuijngsNLI6SjnEJLY,1821
+minisweagent/config/__pycache__/__init__.cpython-313.pyc,sha256=4coMrJJcRL1VCQ7WJW2C2QFD6GnuqvHXkgCpDqxIP9E,1143
+minisweagent/config/extra/__init__.py,sha256=e1MoAlDn_wc9HnXNoncf1P-B4DQ-iRf6n7Q_txjZGRI,52
+minisweagent/config/extra/swebench.yaml,sha256=LNpTahpul6HL0HozgAAz-C6kpX3wZA7Tg8uE-ZmgrF4,7577
+minisweagent/environments/__init__.py,sha256=g5mKac1YgVOZVKvmiAiuyPSevRYpI69V4vYrbCH3gsI,54
+minisweagent/environments/docker.py,sha256=woTrx-e8h_AjW60Tc-fC6m_ZQt1KCk91viLdOXm7k6g,3751
+minisweagent/environments/local.py,sha256=-2EV3RqZSB8WEjJE7BHLhRjocPMLpoJ3HbM8QB1WXUU,1060
+minisweagent/environments/singularity.py,sha256=j7ptRVF8GwDLd-5IjhT5j7fNxEJz9amuLTmVxotaMlI,1796
+minisweagent/environments/extra/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+minisweagent/environments/extra/swerex_docker.py,sha256=MOhhFdX1sAk_U0g-GOxohfjrldzO4YfrUnHq8qJff7c,1502
+minisweagent/models/__init__.py,sha256=-sLha7IXMReJNF1S0aTS3kvqXLlK9sVUw2DukikXh9k,2899
+minisweagent/models/anthropic.py,sha256=D8nHvvbgzPjla0He8p0O9kaXASPWg1Sai0pHsAj_Yn8,855
+minisweagent/models/litellm_model.py,sha256=5Nzln0Iq85Syluz-wGRbv5J_E6T7Mym_0M28tS8lteU,2039
+minisweagent/models/test_models.py,sha256=oB3jmZUire5TkVT8ebUCD3jLuLhPIbcTiTqdIix85Yw,1174
+minisweagent/models/utils/cache_control.py,sha256=mG9cE56HQaUwXfoqvXoH6LcbMV_G1vlEE1aBBpikXYg,1608
+minisweagent/models/utils/key_per_thread.py,sha256=Vlxt--rapNNYCgIHrMCu1WVAkuiVIhC_awbarkbnkZQ,644
+minisweagent/run/__init__.py,sha256=WIoYgHVl7iZF2YncrfV3IttupG6P5KogroKHKECka3A,38
+minisweagent/run/github_issue.py,sha256=GWOkGM09jOYV93p6xIM_kKWmC1yP_d5lprafWlqoBN0,2748
+minisweagent/run/hello_world.py,sha256=erLnEwNmPFLxq3-8zyv66Vy1kIqMqQf97vISX7LrQXg,959
+minisweagent/run/inspector.py,sha256=yk4c-QM0IJ_vd5zXVeyzYLvsA5fhP4L9qL1Lv0zSXcA,7129
+minisweagent/run/mini.py,sha256=LYVxswq0ucieCEALB4U46wOHm4ci33ypkMtN4B8wT90,4267
+minisweagent/run/mini_extra.py,sha256=ecA1PnTWElpO60G9RktvVLtUOf3bZ_ESmnSttS6izhQ,1465
+minisweagent/run/extra/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+minisweagent/run/extra/config.py,sha256=Xf-JKpD4S_yEhiqh7AZWPEGYVu5LrBnpf9teiAoz-wI,3117
+minisweagent/run/extra/swebench.py,sha256=x50nFj4tdXkdoad6TkK7tP8CSgf-WkrY0IdSMe8_oX0,9564
+minisweagent/run/extra/swebench_single.py,sha256=L3Kk4G65o3MCPLMEwGNIs77-AFf6Lfc8o1oxrbN-ZWM,1991
+minisweagent/run/extra/utils/batch_progress.py,sha256=u__khJ-fipZLxTJu43LamGAtPUCqEZYEi8J7SfH7X6A,6211
+minisweagent/run/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+minisweagent/run/utils/save.py,sha256=3_kuutw-uAGIhEoDawA3_FPeSz1vWuCWpJl80j5u7_s,893
+mini_swe_agent-1.1.0.dist-info/METADATA,sha256=UNHcWp5e3LqVY1hiMiUn7M6KvZDeH0YOEfgI1yTrdQU,12202
+mini_swe_agent-1.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mini_swe_agent-1.1.0.dist-info/entry_points.txt,sha256=d1_yRbTaGjs1UXHa6JQK0sKDGBIVGm8oeW0k2kfbJgQ,182
+mini_swe_agent-1.1.0.dist-info/top_level.txt,sha256=zKF4t8bFpV87fdVABZt2Da-vnb4Vkh_CxkwQx5YT4Ew,13
+mini_swe_agent-1.1.0.dist-info/RECORD,,

mini_swe_agent-1.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

mini_swe_agent-1.1.0.dist-info/entry_points.txt

@@ -0,0 +1,5 @@
+[console_scripts]
+mini = minisweagent.run.mini:app
+mini-e = minisweagent.run.mini_extra:main
+mini-extra = minisweagent.run.mini_extra:main
+mini-swe-agent = minisweagent.run.mini:app

mini_swe_agent-1.1.0.dist-info/licenses/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Kilian A. Lieret and Carlos E. Jimenez
+
+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.

mini_swe_agent-1.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+minisweagent

minisweagent/__init__.py

@@ -0,0 +1,67 @@
+"""
+This file provides:
+
+- Path settings for global config file & relative directories
+- Version numbering
+- Protocols for the core components of mini-swe-agent.
+  By the magic of protocols & duck typing, you can pretty much ignore them,
+  unless you want the static type checking.
+"""
+
+__version__ = "1.1.0"
+
+import os
+from pathlib import Path
+from typing import Any, Protocol
+
+import dotenv
+from platformdirs import user_config_dir
+from rich.console import Console
+
+package_dir = Path(__file__).resolve().parent
+
+global_config_dir = Path(os.getenv("MINI_SWE_AGENT_GLOBAL_CONFIG_DIR") or user_config_dir("mini-swe-agent"))
+global_config_dir.mkdir(parents=True, exist_ok=True)
+global_config_file = Path(global_config_dir) / ".env"
+
+if not os.getenv("MINI_SWE_AGENT_SILENT_STARTUP"):
+    Console().print(
+        f"👋 This is [bold green]mini-swe-agent[/bold green] version [bold green]{__version__}[/bold green].\n"
+        f"Your config is stored in [bold green]'{global_config_file}'[/bold green]"
+    )
+dotenv.load_dotenv(dotenv_path=global_config_file)
+
+
+# === Protocols ===
+# You can ignore them unless you want static type checking.
+
+
+class Model(Protocol):
+    """Protocol for language models."""
+
+    config: Any
+    cost: float
+    n_calls: int
+
+    def query(self, messages: list[dict[str, str]], **kwargs) -> dict: ...
+
+
+class Environment(Protocol):
+    """Protocol for execution environments."""
+
+    config: Any
+
+    def execute(self, command: str, cwd: str = "") -> dict[str, str]: ...
+
+
+class Agent(Protocol):
+    """Protocol for agents."""
+
+    model: Model
+    env: Environment
+    messages: list[dict[str, str]]
+
+    def run(self, task: str) -> tuple[str, str]: ...
+
+
+__all__ = ["Agent", "Model", "Environment", "package_dir", "__version__", "global_config_file", "global_config_dir"]

minisweagent/__main__.py

@@ -0,0 +1,7 @@
+#!/usr/bin/env python3
+"""This is what happens when you do `python -m minisweagent` or `pipx run mini-swe-agent`."""
+
+from minisweagent.run.mini import app
+
+if __name__ == "__main__":
+    app()

minisweagent/agents/__init__.py

@@ -0,0 +1 @@
+"""Agent implementations for mini-SWE-agent."""

minisweagent/agents/default.py

@@ -0,0 +1,129 @@
+"""Basic agent class. See https://mini-swe-agent.com/latest/advanced/control_flow/ for visual explanation."""
+
+import os
+import platform
+import re
+import subprocess
+from collections.abc import Callable
+from dataclasses import asdict, dataclass
+
+from jinja2 import Template
+
+from minisweagent import Environment, Model
+
+
+@dataclass
+class AgentConfig:
+    # The default settings are the bare minimum to run the agent. Take a look at the config files for improved settings.
+    system_template: str = "You are a helpful assistant that can do anything."
+    instance_template: str = (
+        "Your task: {{task}}. Please reply with a single shell command in triple backticks. "
+        "To finish, the first line of the output of the shell command must be 'MINI_SWE_AGENT_FINAL_OUTPUT'."
+    )
+    timeout_template: str = (
+        "The last command <command>{{action['action']}}</command> timed out and has been killed.\n"
+        "The output of the command was:\n <output>\n{{output}}\n</output>\n"
+        "Please try another command and make sure to avoid those requiring interactive input."
+    )
+    format_error_template: str = "Please always provide EXACTLY ONE action in triple backticks."
+    action_observation_template: str = "Observation: {{output}}"
+    step_limit: int = 0
+    cost_limit: float = 3.0
+
+
+class NonTerminatingException(Exception):
+    """Raised for conditions that can be handled by the agent."""
+
+
+class FormatError(NonTerminatingException):
+    """Raised when the LM's output is not in the expected format."""
+
+
+class ExecutionTimeoutError(NonTerminatingException):
+    """Raised when the action execution timed out."""
+
+
+class TerminatingException(Exception):
+    """Raised for conditions that terminate the agent."""
+
+
+class Submitted(TerminatingException):
+    """Raised when the LM declares that the agent has finished its task."""
+
+
+class LimitsExceeded(TerminatingException):
+    """Raised when the agent has reached its cost or step limit."""
+
+
+class DefaultAgent:
+    def __init__(self, model: Model, env: Environment, *, config_class: Callable = AgentConfig, **kwargs):
+        self.config = config_class(**kwargs)
+        self.messages: list[dict] = []
+        self.model = model
+        self.env = env
+
+    def render_template(self, template: str, **kwargs) -> str:
+        cs = asdict(self.config) | asdict(self.env.config) | asdict(self.model.config) | platform.uname()._asdict()
+        return Template(template).render(**kwargs, **cs, **os.environ)
+
+    def add_message(self, role: str, content: str):
+        self.messages.append({"role": role, "content": content})
+
+    def run(self, task: str) -> tuple[str, str]:
+        """Run step() until agent is finished. Return exit status & message"""
+        self.messages = []
+        self.add_message("system", self.config.system_template)
+        self.add_message("user", self.render_template(self.config.instance_template, task=task))
+        while True:
+            try:
+                self.step()
+            except NonTerminatingException as e:
+                self.add_message("user", str(e))
+            except TerminatingException as e:
+                self.add_message("user", str(e))
+                return type(e).__name__, str(e)
+
+    def step(self) -> dict:
+        """Query the LM, execute the action, return the observation."""
+        return self.get_observation(self.query())
+
+    def query(self) -> dict:
+        """Query the model and return the response."""
+        if 0 < self.config.step_limit <= self.model.n_calls or 0 < self.config.cost_limit <= self.model.cost:
+            raise LimitsExceeded()
+        response = self.model.query(self.messages)
+        self.add_message("assistant", response["content"])
+        return response
+
+    def get_observation(self, response: dict) -> dict:
+        """Execute the action and return the observation."""
+        output = self.execute_action(self.parse_action(response))
+        observation = self.render_template(self.config.action_observation_template, output=output)
+        self.add_message("user", observation)
+        return output
+
+    def parse_action(self, response: dict) -> dict:
+        """Parse the action from the message. Returns the action."""
+        actions = re.findall(r"```bash\n(.*?)\n```", response["content"], re.DOTALL)
+        if len(actions) == 1:
+            return {"action": actions[0].strip(), **response}
+        raise FormatError(self.render_template(self.config.format_error_template, actions=actions))
+
+    def execute_action(self, action: dict) -> dict:
+        try:
+            output = self.env.execute(action["action"])
+        except subprocess.TimeoutExpired as e:
+            output = e.output.decode("utf-8", errors="replace") if e.output else ""
+            raise ExecutionTimeoutError(
+                self.render_template(self.config.timeout_template, action=action, output=output)
+            )
+        except TimeoutError:
+            raise ExecutionTimeoutError(self.render_template(self.config.timeout_template, action=action, output=""))
+        self.has_finished(output)
+        return output
+
+    def has_finished(self, output: dict[str, str]):
+        """Raises Submitted exception with final output if the agent has finished its task."""
+        lines = output.get("output", "").lstrip().splitlines()
+        if lines and lines[0].strip() == "MINI_SWE_AGENT_FINAL_OUTPUT":
+            raise Submitted("\n".join(lines[1:]))