Metadata-Version: 2.1
Name: elroy
Version: 0.0.12
Summary: 
Author: Elroy Bot
Author-email: bot@elroy.ai
Requires-Python: >=3.11,<3.12
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: alembic (>=1.13.2,<2.0.0)
Requires-Dist: bumpversion (>=0.6.0,<0.7.0)
Requires-Dist: celery (>=5.3.6,<6.0.0)
Requires-Dist: colorama (>=0.4.6,<0.5.0)
Requires-Dist: cryptography (>=42.0.7,<43.0.0)
Requires-Dist: docker (>=7.1.0,<8.0.0)
Requires-Dist: docstring-parser (>=0.16,<0.17)
Requires-Dist: litellm (>=1.49.6,<2.0.0)
Requires-Dist: openai (>=1.37.0,<2.0.0)
Requires-Dist: pgvector (>=0.2.4,<0.3.0)
Requires-Dist: prompt-toolkit (>=3.0.47,<4.0.0)
Requires-Dist: psycopg2-binary (>=2.9.9,<3.0.0)
Requires-Dist: pydantic (>=2.8.2,<3.0.0)
Requires-Dist: pygments (>=2.18.0,<3.0.0)
Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
Requires-Dist: pytz (>=2024.1,<2025.0)
Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
Requires-Dist: requests (>=2.32.2,<3.0.0)
Requires-Dist: rich (>=13.7.1,<14.0.0)
Requires-Dist: sqlalchemy (>=2.0.29,<3.0.0)
Requires-Dist: sqlmodel (>=0.0.21,<0.0.22)
Requires-Dist: tiktoken (>=0.7.0,<0.8.0)
Requires-Dist: toolz (>=0.12.1,<0.13.0)
Requires-Dist: typer (>=0.12.5,<0.13.0)
Description-Content-Type: text/markdown

# Elroy

Elroy is an CLI AI personal assistant with long term memory and goal tracking capabilities.

## Installation

There are two ways to install and run Elroy:

### 1. Using pipx (Recommended)

#### Prerequisites
- Python 3.11 or higher
- pipx: Install with `python3.11 -m pip install --user pipx`
- OpenAI key: Set the `OPENAI_API_KEY` environment variable

#### Installation
```
pipx install --python python3.11 elroy
```

To run:
```
elroy
```

### 2. Docker Requirement

#### Prerequisites
- Docker: [Install Docker](https://docs.docker.com/get-docker/)
- Docker daemon must be running (Elroy uses it to create a PostgreSQL container)
- OpenAI key: Set the `OPENAI_API_KEY` environment variable

Note: You don't need to run Elroy in Docker - it just needs Docker running to manage its PostgreSQL database.

## License

Distributed under the GPL 3.0.1 License. See `LICENSE` for more information.

