Skip to main content

a clone from the root project for Ryoma AI Platform – made compatible with Pydantic v2

Project description

Ryoma Nicer

A Pydantic v2–compatible fork of Ryoma AI Platform


Overview

Ryoma Nicer is a community-maintained fork of the Ryoma AI Platform, originally created by the Ryoma team. The upstream project provides an AI-powered data agent framework for seamless data analysis, engineering, and visualization.

This fork is:

  • Pydantic v2–compatible (ryoma-nicer runs on Pydantic 2.x)
  • LangGraph-ready, updated for modern LangGraph (StateGraph + Pregel) APIs
  • Actively maintained as part of the “NICER” suite of agents (e.g. baby-NICER)

It is used in production within the NICER stack to power agents such as WorkflowAgent and SQL agents that run on a LangGraph / LangChain / LangMem tooling ecosystem.

For the original project, see project-ryoma/ryoma. All architectural credit for the base design goes to the upstream maintainers.

Why This Fork?

Pydantic v2 introduced breaking changes in how models are defined and validated. Many projects, including the original Ryoma AI Platform, were tightly coupled to Pydantic v1. To allow developers to adopt the latest Pydantic improvements without sacrificing Ryoma functionality, this fork:

  1. Migrates all core model definitions to the Pydantic v2 BaseModel API.
  2. Updates validation and config patterns to leverage v2’s faster runtime and stricter type checking.
  3. Aligns with a modern agent stack, including:
    • LangGraph (tested with langgraph==0.6.x)
    • LangChain / LangChain Core (tested with langchain==0.3.x, langchain-core==0.3.x)
    • Usage inside the NICER suite of agents (e.g. baby-NICER / langgraph-slack).

Installation

Install the Pydantic v2–compatible release from PyPI:

pip install ryoma-nicer

Optionally, include supported data source extras:

pip install "ryoma-nicer[snowflake,pyspark,postgres,sqlite,mysql,bigquery]"

Usage

The API surface and usage mirror the original Ryoma. For example, to run a simple SQL agent:

from ryoma_ai.agent.sql import SqlAgent
from ryoma_ai.datasource.postgres import PostgresDataSource

# Initialize data source
datasource = PostgresDataSource("postgresql://user:pass@host:5432/db")

# Create and run SQL agent
agent = SqlAgent("gpt-3.5-turbo").add_datasource(datasource)
agent.stream("SELECT count(*) FROM orders", display=True)

For conceptual details and additional examples, the upstream Ryoma documentation still applies in most cases. Where this fork differs is primarily in:

  • Pydantic v2 model definitions
  • Updated integrations used by the NICER agent stack

Usage in the NICER agent suite

Within the NICER ecosystem (e.g. baby-NICER / langgraph-slack), this fork powers agents that run on LangGraph’s compiled graphs (StateGraph.compile(...) returning a Pregel runtime). For example, WorkflowAgent:

  • builds a StateGraph over MessageState
  • compiles it to a Pregel runtime with MemorySaver checkpointers
  • uses LangGraph’s invoke/stream APIs to manage tool-augmented workflows

This ensures ryoma-nicer works cleanly with modern LangGraph-based systems while preserving the spirit of the original Ryoma design.

Contribution & Upstream

  • Forked from: project-ryoma/ryoma
  • Upstream credit: Architectural ideas, core abstractions, and much of the original code come from the Ryoma team.
  • Issue tracker & pull requests: Please use this repository to report Pydantic v2 / modern-stack compatibility issues or to propose improvements needed by the NICER suite of agents.

License

This project is released under the Apache License 2.0.

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

ryoma_nicer-0.7.5.tar.gz (2.6 MB view details)

Uploaded Source

Built Distribution

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

ryoma_nicer-0.7.5-py3-none-any.whl (143.2 kB view details)

Uploaded Python 3

File details

Details for the file ryoma_nicer-0.7.5.tar.gz.

File metadata

  • Download URL: ryoma_nicer-0.7.5.tar.gz
  • Upload date:
  • Size: 2.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for ryoma_nicer-0.7.5.tar.gz
Algorithm Hash digest
SHA256 ba73910ae5a9b9ad580aad3077e8f442244cea05d26f7a8efd42c9309732f0b1
MD5 a444773977c4562cc0c7e61b0ae41f0a
BLAKE2b-256 568cba1c9cc8ea87d83bbd8b7141c6cbd5d1bfb27ea281cb7bbd59f46a3f1f63

See more details on using hashes here.

File details

Details for the file ryoma_nicer-0.7.5-py3-none-any.whl.

File metadata

  • Download URL: ryoma_nicer-0.7.5-py3-none-any.whl
  • Upload date:
  • Size: 143.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for ryoma_nicer-0.7.5-py3-none-any.whl
Algorithm Hash digest
SHA256 92b099c5eea23d75680faca716537f53cf2920879500ca5bd2c31474a40c80f6
MD5 ace6e7d3fad811e4779aec2424d7cce1
BLAKE2b-256 9ec78e706eb7f715790fe6928d2b7e865451c65b452e2da7d151b13d7fc54170

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