pydantic-to-typescript2

What it is and what it does

pydantic-to-typescript2 is a command-line tool that reads Pydantic model definitions from Python modules and generates corresponding TypeScript interface definitions. It bridges the gap between Python and JavaScript/TypeScript codebases by allowing you to define your data schemas once in Pydantic and automatically export them as TypeScript types, eliminating the need to manually maintain duplicate type definitions across languages.

The tool scans Python modules for Pydantic models, converts them to JSON Schema, and then uses the json2ts utility to generate TypeScript interfaces. It can be invoked via CLI with module and output file paths, or programmatically. It supports excluding specific models and customizing the json2ts command invocation.

Use it for:

• Synchronize API request/response types between a Python backend and a TypeScript frontend without manual duplication.
• Generate TypeScript types for a Python service's data models to ensure frontend code matches backend contracts.
• Automate type definition generation in a monorepo where Python and JavaScript services share domain models.
• Export Pydantic validation schemas as TypeScript interfaces for client-side type checking and IDE autocomplete.
• Maintain a single source of truth for data structures across polyglot microservices.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Converts Pydantic models to TypeScript interfaces via a CLI tool, enabling shared type definitions between Python and JavaScript applications.

Yes, if you maintain both Python and TypeScript codebases that share data models. The low install friction and permissive license make it practical for eliminating type definition drift. However, maintenance is dormant—verify compatibility with your specific Pydantic and TypeScript versions before adopting, and plan for potential maintenance gaps if ecosystem changes occur.

Install

pydantic-to-typescript2 on PyPI

pip install pydantic-to-typescript2

uv add pydantic-to-typescript2

poetry add pydantic-to-typescript2

Installing pydantic-to-typescript2

Before you install

Low install friction with a single runtime dependency on pydantic. Maintenance is dormant (701 days since last release), though the package is marked Production/Stable and supports Python 3.8 through 3.12.

License in practice

MIT license is permissive, allowing use in commercial and private projects with minimal restrictions.

Quickstart

pip install pydantic-to-typescript2

# CLI usage:
pydantic2ts --module backend.api --output ./frontend/apiTypes.ts

# Or programmatic usage via the package's generate function

Requires the json2ts CLI utility (json-schema-to-typescript npm package) to be installed and accessible on the system PATH.

Verify before relying

• Whether dormant maintenance status affects compatibility with recent Pydantic releases or TypeScript ecosystem changes.
• Actual test coverage and reliability for complex nested Pydantic models or advanced field configurations.
• Performance characteristics when converting large codebases with many models.

Package facts

Evidence: pydantic_to_typescript2-1.0.6-py3-none-any.whl

Keywords: pydantic, pydantic2, typescript, annotations, validation, interface

Tags

More Software Development packages