Skip to main content

nagents

PyPI version Python versions CI codecov License: MIT Docs

A lightweight LLM agent framework with direct HTTP-based provider integration.

Features

  • Multi-Provider Support: OpenAI, Anthropic Claude, and Google Gemini APIs
  • Streaming Events: Real-time text chunks, tool calls, and usage statistics
  • Tool Execution: Register Python functions as tools with automatic schema generation
  • Session Management: SQLite-based conversation persistence
  • Batch Processing: Process multiple requests efficiently
  • Python Harness Extensions: Custom context transforms, lifecycle hooks, and replaceable compaction algorithms
  • Optional Terminal Client: ngn provides interactive coding, approvals, sessions, and headless JSON events
  • Minimal Dependencies: Only aiohttp and aiosqlite required

Library Installation

pip install nagents

ngn Terminal Client

ngn is an optional terminal and headless coding harness in this source checkout, not yet a published CLI release. pip install nagents installs the published library; do not assume it includes these unreleased CLI features.

Keep the existing Poetry workflow from the repository root:

poetry install -E dev -E tui
poetry run ngn --demo

For a new local editable environment with uv, from the repository root:

uv venv --python 3.13
uv pip install --python .venv/bin/python -e '.[tui]'
uv run --no-project --python .venv/bin/python ngn --demo

Do not recreate an existing Poetry-managed .venv; keep using Poetry or choose a separate local environment. This uv workflow does not require uv sync, uv lock, or changes to the existing uv.lock. The explicit interpreter needs no activation. See ngn installation for optional activation, headless-only installation, and isolated uvx/uv tool alternatives.

The offline demo needs no API key, makes no model requests, skips Python plugins, and performs no workspace edits or shell commands. It does save demo conversations locally. Send demo approval to try a change-preview dialog or demo subagents to exercise three native async jobs without provider calls.

For a real model, set the provider key outside TOML and launch through the same environment, for example poetry run ngn --auth api-key --model MODEL_ID or uv run --no-project --python .venv/bin/python ngn --auth api-key --model MODEL_ID. With the environment activated, use ngn run --json "your prompt" for headless integration. Non-interactive approvals fail closed.

Type / for selectable commands from the harness, skills, and trusted plugins. Shift+Enter inserts a newline; Tab cycles agent profiles. Input queues while work is active, or use --submit-mode interrupt. The default terminal theme inherits terminal colors; try --theme graphite, ocean, or ember, and disable motion with --no-animations. Build-capable delegation uses the built-in agent profile by default, never exceeds the parent's permissions, and defaults to depth two (root 0, child 1, grandchild 2).

For ChatGPT/Codex subscription access, start ngn without --demo and use /login, or run ngn login --device-auth. Device login must be enabled in your ChatGPT security/workspace settings. This uses a separate Codex Responses route, not a general-purpose OpenAI API key. See the guide for credential storage and --auth api-key selection. Saved OAuth tokens are never sent to custom endpoints.

Configuration uses top-level TOML, not [ngn] sections. Priority is built-ins < NGN_* environment defaults < global TOML < trusted project TOML < explicit TOML < CLI. The global file is ~/.config/ngn/config.toml (respecting XDG_CONFIG_HOME); workspace .ngn/config.toml needs --trust-project, or explicit selection with --config. Any explicitly selected config file is trusted. See the full schema and recipes for types, defaults, ranges, profile replacement, relative paths, and LiteLLM endpoints.

Optional microphone dictation uses the voice extra, a separate transcription API-key reference, and explicit opt-in. Transcriptions become editable previews, not automatically sent prompts. ChatGPT subscription access does not cover the paid transcription API. See dictation.

Python plugins can change how the agent builds context, compacts history, and executes tools. The TUI uses the same harness as the headless client; Textual remains an optional dependency. See the ngn usage guide, custom Python behavior example, and upstream research.

Quick Start

import asyncio
from pathlib import Path
from nagents import Agent, Provider, ProviderType, SessionManager


async def main():
    # Create a provider
    provider = Provider(
        provider_type=ProviderType.OPENAI_COMPATIBLE,
        api_key="your-api-key",
        model="gpt-4o-mini",
    )

    # Create an agent
    agent = Agent(
        provider=provider,
        session_manager=SessionManager(Path("sessions.db")),
        streaming=True,
    )

    # Run a conversation
    async for event in agent.run("Hello, how are you?"):
        if hasattr(event, "chunk"):
            print(event.chunk, end="")

    await agent.close()


asyncio.run(main())

Providers

nagents supports three provider types:

Provider Type Models
OpenAI ProviderType.OPENAI_COMPATIBLE gpt-4o, gpt-4o-mini, etc.
Anthropic ProviderType.ANTHROPIC claude-3-5-sonnet, claude-3-opus, etc.
Google ProviderType.GEMINI_NATIVE gemini-2.0-flash, gemini-1.5-pro, etc.

With Tools

def get_weather(city: str) -> str:
    """Get the current weather for a city."""
    return f"Weather in {city}: Sunny, 22°C"


agent = Agent(
    provider=provider,
    session_manager=SessionManager(Path("sessions.db")),
    tools=[get_weather],
)

async for event in agent.run("What's the weather in Paris?"):
    ...

With Session Persistence

from pathlib import Path
from nagents import SessionManager

session_manager = SessionManager(Path("sessions.db"))

agent = Agent(
    provider=provider,
    session_manager=session_manager,
)

# Use a specific session ID for conversation continuity
async for event in agent.run("Remember my name is Alice", session_id="user-123"):
    ...

Documentation

License

MIT

Release files for nagents 0.5.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for nagents 0.5.0
File Size Uploaded
nagents-0.5.0.tar.gz 272.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for nagents 0.5.0
File Interpreter ABI Platform
nagents-0.5.0-py3-none-any.whl Python 3 none any Details

Total release size: 524.9 kB

Release files / nagents-0.5.0.tar.gz

Download URL nagents-0.5.0.tar.gz
Size 272.2 kB
Tags Source
SHA-256 checksum
How to use checksums
4d36479b460d1bdf2fcc2cc74ed1567c003fca984e5537a71cb9b21c623dfe07
BLAKE2b-256 checksum
How to use checksums
d5a448ef44daf7583e7946165dc3f9cc97f75b2b4692eb4d5557f84a391882fb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 7, 2026.

Transparency log

Release files / nagents-0.5.0-py3-none-any.whl

Download URL nagents-0.5.0-py3-none-any.whl
Size 252.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f0d91dcec10279e93d5fcba9a3e669af5d0aab40e71b227a570db0f1be7f05e1
BLAKE2b-256 checksum
How to use checksums
a66b17bdc564d5d6be3e3cc8fc2c589fb5c2ca9b54de6fb677eb86ad24177fea
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 7, 2026.

Transparency log

Release history Release notifications | RSS feed

0.13.2

2 release files

0.13.1

2 release files

0.13.0

2 release files

0.12.0

2 release files

0.11.0

2 release files

0.10.3

2 release files

0.10.2

2 release files

0.10.1

2 release files

0.10.0

2 release files

0.9.1

2 release files

0.9.0

2 release files

0.8.0

2 release files

0.7.0

2 release files

This release

0.5.0 This release

2 release files

0.4.4

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.29

2 release files

0.2.28

2 release files

0.2.25

2 release files

0.2.24

2 release files

0.2.23

2 release files

0.2.22

2 release files

0.2.21

2 release files

0.2.20

2 release files

0.2.19

2 release files

0.2.18

2 release files

0.2.14

2 release files

0.2.13

2 release files

0.2.12

2 release files

0.2.11

2 release files

0.2.10

2 release files

0.2.9

2 release files

0.2.8

2 release files

0.2.7

2 release files

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.9

2 release files

0.1.6

2 release files

0.1.5

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page