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 designed to ensure compatibility with Pydantic v2. The original Ryoma provides an AI-powered data agent framework for seamless data analysis, engineering, and visualization. This fork:

  • Upgrades internal data models to use Pydantic v2 APIs
  • Preserves feature parity with the upstream Ryoma project
  • Offers a drop-in replacement package (ryoma-nicer) for users on Pydantic v2

For the original project, see project-ryoma/ryoma. Thanks to the upstream maintainers for their work!

Why This Fork?

Pydantic v2 introduced breaking changes in how models are defined and validated. Many projects, including 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 `` model definitions to the new BaseModel API in v2.
  2. Updates validation logic to leverage v2’s faster runtime and stricter type checks.
  3. **Releases under **`` as a PyPI package, ensuring it can be installed alongside Pydantic v2.

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)

See the Ryoma Nicer documentation for full examples.

Contribution & Upstream

  • Forked from: project-ryoma/ryoma
  • Issue tracker & pull requests: Please use this repository to report Pydantic v2 compatibility issues or propose improvements.

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.5.1.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.5.1-py3-none-any.whl (139.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ryoma_nicer-0.5.1.tar.gz
Algorithm Hash digest
SHA256 1c67286fb8425888da0557097481535f3d5c4252e2851c9359f23baa061e1656
MD5 c39533957c6b56f10396e2c7c18ba9b8
BLAKE2b-256 f1ad6e87aec819c252d14e207f559e61fb2f8a8a4906c5867dfd92d2bdd3bf1f

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ryoma_nicer-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e461d816722f29e858d58167ebcdbd273f83e4e85f3a142a0f6ca57c9471ac31
MD5 e6ccac4b3dc9d9ebcc0a074b2a7e3cdf
BLAKE2b-256 5b650b3c583406d2c786c9efec5357d4013d2eaa1116156292555cd122496537

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