Interact with LLMs via email
Project description
LLMail
Interact with Large Language Models (LLMs) via email.
Features
- Utilize any OpenAI-compatible API
- At the time of writing, OpenRouter offers free access to specific models with an OpenAI-compatible API
- Check every n seconds
- No need for a local database - uses IMAP
Prerequisites
Python
- Python ^3.11
- Poetry (optional)
- An API key from an OpenAI-compatible API
Docker
- Docker
Usage
Installing from PyPi with pip
(recommended)
This assumes you have the correct version of Python installed
pip install llmail
a. You may need to usepip3
instead ofpip
llmail
Installation from source or with Docker
Cloning the repository is not required when installing from PyPi but is required when installing from source
- Clone this repo with
git clone https://github.com/slashtechno/llmail
cd
into the cloned repository- Install and run with one of the following methods:
Poetry
poetry install
poetry run -- llmail
Docker
- Configure with the steps below
docker compose up -d
Configuration
To configure the program, either use CLI flags (--help
for more information) or environment variables.
It is recommended to just copy .env.example
to .env
and fill in the necessary information.
How to uninstall
- If you used Poetry, just delete the virtual environment and then the cloned repository
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
llmail-0.2.1.tar.gz
(21.2 kB
view hashes)
Built Distribution
llmail-0.2.1-py3-none-any.whl
(22.0 kB
view hashes)