py2ts

TypeScript type definitions from Python type hints

Features

Complex Types Support: Handle complex types such as enums and nested typed dictionaries.
Generic Types Support: Convert Python generics (TypeVars, bounded parameters, parametrized references) to TypeScript generics, including recursive and pydantic models.
Comprehensive Documentation: Access detailed documentation, including a Quickstart Guide and API Reference, to help you get started and understand the library's capabilities.

Installation

You can install Py2Ts from pypi directly using pip:

pip install python2ts

Quickstart

To generate TypeScript type definitions from Python type hints, use the generate_ts function from the py2ts.generate module. Here's an example:

from py2ts import generate_ts

class Person:
    name: str
    age: int

print(generate_ts(Person))

This will output the following TypeScript type definition:

export interface Person {
    name: string;
    age: number;
}

Please refer to the Quickstart Guide for more examples and detailed instructions.

Complex Types Support

Py2Ts supports complex types such as enums and nested typed dictionaries. Here's an example:

from __future__ import annotations
from enum import Enum
from typing_extensions import NotRequired
from typing import TypedDict
from py2ts import generate_ts

class Color(Enum):
    RED = 1
    GREEN = "green"
    BLUE = "blue"   

class Polygon(TypedDict):
    color: Color
    edges: NotRequired[int]
    children: list[Polygon] | None

ts = generate_ts(Polygon)

print(ts.full_str())

This will output the following TypeScript type definition:

export enum Color {
	RED = 1,
	GREEN = 'green',
	BLUE = 'blue',
}

export interface Polygon {
	color: Color;
	edges?: number;
	children: Array<Polygon> | null;
}

Generic Types Support

Py2Ts converts Python generic classes to TypeScript generics. Type parameters, bounds, parametrized references and recursive generics are supported:

from typing import Generic, TypeVar
from dataclasses import dataclass
from py2ts import generate_ts

T = TypeVar("T")

@dataclass
class Node(Generic[T]):
    value: T
    next: "Node[T] | None" = None

print(generate_ts(Node).full_str())

export interface Node<T> {
	value: T;
	next: Node<T> | null;
}

Bounded type parameters render as T extends ... (e.g. TypeVar("T", bound=str) becomes T extends string), and instantiations keep their type arguments (e.g. Node[str] becomes Node<string>). Pydantic generic models are supported as well. See the Supported Types page for details.

Download files

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

Source Distribution

python2ts-0.7.1.tar.gz (211.5 kB view details)

Uploaded Aug 28, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

python2ts-0.7.1-py3-none-any.whl (28.1 kB view details)

Uploaded Aug 28, 2026 Python 3

File details

Details for the file python2ts-0.7.1.tar.gz.

File metadata

Download URL: python2ts-0.7.1.tar.gz
Upload date: Aug 28, 2026
Size: 211.5 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for python2ts-0.7.1.tar.gz
Algorithm	Hash digest
SHA256	`569bdbead395279e522d9f6d19a0aaf9a7e9573830c928674a5da20529b928c9`
MD5	`556e894acf1a8be318c309e0069d8111`
BLAKE2b-256	`cdf770d8d722c12f18f2311090237bdda0f5b2766474959ad7fbd980d4eccfeb`

See more details on using hashes here.

Provenance

The following attestation bundles were made for python2ts-0.7.1.tar.gz:

Publisher: release.yml on semohr/py2ts

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: python2ts-0.7.1.tar.gz
- Subject digest: 569bdbead395279e522d9f6d19a0aaf9a7e9573830c928674a5da20529b928c9
- Sigstore transparency entry: 2626022660
- Sigstore integration time: Aug 28, 2026
Source repository:
- Permalink: semohr/py2ts@94910f96c22e17ef3e44cba51bb61ed6c0d8a590
- Branch / Tag: refs/tags/v0.7.1
- Owner: https://github.com/semohr
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@94910f96c22e17ef3e44cba51bb61ed6c0d8a590
- Trigger Event: release