Metadata-Version: 2.4
Name: local-axiom-agent
Version: 1.0.0
Summary: A local-first AI orchestration framework
Author-email: rutytoi <charlesbbm@outlook.fr>
License: MIT
Keywords: ai,llm,orchestration,agents,tools,local-first
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.28.0
Requires-Dist: aiosqlite>=0.19.0
Requires-Dist: psutil>=5.9.0
Requires-Dist: numpy>=1.24.0
Requires-Dist: pyautogui>=0.9.53
Requires-Dist: pillow>=10.1.0
Requires-Dist: opencv-python>=4.8.0
Requires-Dist: websockets>=12.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
Requires-Dist: pytest-cov>=3.0; extra == "dev"
Requires-Dist: black>=22.0; extra == "dev"
Requires-Dist: flake8>=4.0; extra == "dev"
Requires-Dist: mypy>=0.950; extra == "dev"
Requires-Dist: isort>=5.0; extra == "dev"
Dynamic: license-file

# AXIOM

[![CI/CD Pipeline](https://github.com/rutytoi/axiom/actions/workflows/release.yml/badge.svg)](https://github.com/rutytoi/axiom/actions/workflows/release.yml)
[![Python Version](https://img.shields.io/badge/python-3.12%2B-blue.svg)](https://www.python.org/downloads/release/python-3120/)

AXIOM is a local-first AI execution system for coordinating tools, agents, memory, and desktop automation without requiring a cloud control plane.

## Core capabilities

<div align="center">
  <!-- TODO: Record an animated GIF of AXIOM executing a multi-step local tool sequence and save it as assets/demo.gif -->
  <img src="assets/demo.gif" alt="AXIOM Terminal Output Demo" width="800">
  <p><em>AXIOM v1.0 executing a local tool sequence</em></p>
</div>

- Event-driven execution and component registries
- Local Ollama integration
- Persistent local memory
- Sandboxed file and shell tooling
- Deterministic execution plans with dependency tracking and confirmation gates

## Quick Start

### Installation

Clone the repository and install the package:

```bash
git clone https://github.com/rutytoi/axiom.git
cd axiom
pip install -e .
```

Note: You must have [Ollama](https://ollama.com/) installed and running locally.

### Usage

Start the interactive AXIOM terminal:

```bash
axiom
```

You can now chat with the orchestrator, ask for system `status`, view registered `tools`, or type `help` for more commands.

For a full guide on using tools, agents, and Python integration, see [QUICKSTART.md](QUICKSTART.md).

## Extending AXIOM

AXIOM is designed to be easily extensible. You can build your own agents and tools to customize the orchestration layer.
Check out the starter scripts in the `examples/` directory:
- [examples/example_custom_agent.py](examples/example_custom_agent.py) - How to build and register custom agents
- [examples/example_custom_tool.py](examples/example_custom_tool.py) - How to build custom tools

## Development

Run the tests with:

```bash
python -m pytest tests/
```

Build a distribution with:

```bash
python -m pip wheel --no-deps --no-build-isolation .
```
