Skip to main content

LLM plugin for iaedu.pt API — no adapter required

Project description

llm-iaedu

Plugin for LLM that enables using the iaedu.pt API as a model — no adapter, no Docker.

Quick Start

Linux / macOS

# Install
pip install llm-iaedu

# Configure credentials (Endpoint, API Key, Channel ID)
llm-iaedu configure

# Ask anything
llm -m iaedu "What is the capital of Portugal?"

# Optional — make iaedu the default model:
llm models default iaedu
llm "What is the capital of Portugal?"

Ubuntu / Debian (PEP 668)

Ubuntu 23.04+ blocks system-wide pip install. Use one of:

Option 1: pipx (if you already pipx install llm):

# Install plugin into llm's venv
pipx inject llm llm-iaedu

# One-time setup — paste 3 values from iaedu.pt:
llm iaedu-configure

# That's it — no need for `llm keys set iaedu`
llm -m iaedu "What is the capital of Portugal?"

To upgrade after install:

pipx runpip llm install --upgrade llm-iaedu

Option 2: Virtual environment:

python3 -m venv venv
source venv/bin/activate
pip install llm-iaedu
llm-iaedu configure
llm -m iaedu "What is the capital of Portugal?"

Option 3: From git clone:

git clone https://github.com/rodolfomatos/llm-iaedu.git
cd llm-iaedu
make ubuntu-setup   # shows instructions
make configure      # interactive credential setup
make check          # verify everything works

Setup

Quick (interactive) — one step

# From git clone (has Makefile):
make configure

# From pip install (no repo):
llm-iaedu configure

# From pipx inject (llm subcommand):
llm iaedu-configure

Paste the three values from iaedu.pt (Endpoint URL, API Key, Channel ID) when prompted. The script creates ~/.config/iaedu/env with everything needed — no llm keys set iaedu required, works from any directory.

Manual

Create ~/.config/iaedu/env:

IAEDU_ENDPOINT=https://api.iaedu.pt/agent-chat/api/v1/agent/your-agent-id/stream
IAEDU_CHANNEL_ID=your-channel-id
IAEDU_API_KEY=your-api-key

Or place a .env in any project directory for local config.

Config Precedence

  1. Current shell (export IAEDU_*)
  2. ./.env (local)
  3. ~/.config/iaedu/env (global)
  4. ~/.iaedu.env (legacy)

Usage

# One-off
llm -m iaedu "What is the capital of Portugal?"

# Default model (just skip -m)
llm models default iaedu
llm "What is the capital of Portugal?"

# Interactive chat
llm chat -m iaedu

# Pipe input
cat file.txt | llm -m iaedu

Development

git clone https://github.com/rodolfomatos/llm-iaedu.git
cd llm-iaedu

# Standard
make setup
# ... or Ubuntu/Debian:
make ubuntu-setup
# ... or pipx:
make pipx-setup

make configure
make check

How it works

The plugin calls the iaedu.pt API directly — no adapter server required. It loads config from environment variables or .env files, sends prompts as multipart form data, and streams token responses.

Requirements

  • Python 3.8+
  • llm CLI
  • iaedu.pt account with API key, channel ID, and agent ID

Project

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

llm_iaedu-0.5.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

llm_iaedu-0.5-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file llm_iaedu-0.5.tar.gz.

File metadata

  • Download URL: llm_iaedu-0.5.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for llm_iaedu-0.5.tar.gz
Algorithm Hash digest
SHA256 aa448144f11848acb87096614eeb4f9c91d01b718884c9623004ef7b05309642
MD5 f631d7ac3e0a211d31db96833baf9a5a
BLAKE2b-256 dfc2d927b24998f68cad2c5f99abddbf03a9b2628a2b8f95a86b7f4da6dfb69a

See more details on using hashes here.

File details

Details for the file llm_iaedu-0.5-py3-none-any.whl.

File metadata

  • Download URL: llm_iaedu-0.5-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.12

File hashes

Hashes for llm_iaedu-0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 13e53565ca2f627262133afbff9638278cc4cbbeb15996bb6c78360db05e19c1
MD5 b2a05b8243b48b115b1c420a91c36bad
BLAKE2b-256 209f228c615be1b3a629d75cbae4130452bc825ad031256f976e54d5b45d1e5e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page