python2ts 0.1.0 → 0.2.0

package/README.md

@@ -1,37 +1,32 @@
 # python2ts
 
 [![npm version](https://img.shields.io/npm/v/python2ts.svg)](https://www.npmjs.com/package/python2ts)
+[![npm downloads](https://img.shields.io/npm/dm/python2ts.svg)](https://www.npmjs.com/package/python2ts)
+[![CI](https://github.com/sebastian-software/python2ts/actions/workflows/ci.yml/badge.svg)](https://github.com/sebastian-software/python2ts/actions/workflows/ci.yml)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.6-blue.svg)](https://www.typescriptlang.org/)
 [![License](https://img.shields.io/npm/l/python2ts.svg)](https://github.com/sebastian-software/python2ts/blob/main/LICENSE)
 
 **AST-based Python to TypeScript transpiler** — Write Python, ship TypeScript.
 
-Converts Python code to clean, idiomatic TypeScript with full type preservation.
+> Convert Python code to clean, idiomatic TypeScript with full type preservation.
 
-## Installation
+## Quick Start
 
 ```bash
 npm install python2ts
 ```
 
-## CLI Usage
-
 ```bash
 # Transpile a file
 npx python2ts input.py -o output.ts
 
 # Pipe from stdin
 cat script.py | npx python2ts > script.ts
-
-# Preview without runtime import
-npx python2ts input.py --no-runtime
 ```
 
-## API Usage
-
-```typescript
-import { transpile } from "python2ts"
+## Example
 
-const typescript = transpile(`
+```python
 def fibonacci(n: int) -> list[int]:
     a, b = 0, 1
     result = []
@@ -39,10 +34,9 @@ def fibonacci(n: int) -> list[int]:
         result.append(a)
         a, b = b, a + b
     return result
-`)
 ```
 
-**Output:**
+Becomes:
 
 ```typescript
 import { range } from "pythonlib"
@@ -58,91 +52,27 @@ function fibonacci(n: number): number[] {
 }
 ```
 
-## What Gets Transpiled?
-
-| Python                       | TypeScript                            |
-| ---------------------------- | ------------------------------------- |
-| `int`, `str`, `bool`, `None` | `number`, `string`, `boolean`, `null` |
-| `list[T]`, `dict[K,V]`       | `T[]`, `Record<K,V>`                  |
-| `Optional[T]`                | `T \| null`                           |
-| `def fn():`                  | `function fn()`                       |
-| `lambda x: x + 1`            | `(x) => x + 1`                        |
-| `class Child(Parent):`       | `class Child extends Parent`          |
-| `@dataclass`                 | Auto-generated constructor            |
-| `for x in items:`            | `for (const x of items)`              |
-| `if/elif/else`               | `if/else if/else`                     |
-| `match/case`                 | `switch/case`                         |
-| `async def` / `await`        | `async function` / `await`            |
-| `//` (floor div)             | `floordiv()` (Python semantics)       |
-| `%` (modulo)                 | `mod()` (Python semantics)            |
-| `arr[1:-1]` (slicing)        | `slice()` (full support)              |
-| `f"Hello {name}"`            | `` `Hello ${name}` ``                 |
-| `"""docstring"""`            | `/** JSDoc */`                        |
-
-## Advanced API
+## Documentation
 
-```typescript
-import { parse, transform, generate } from "python2ts"
-
-// Step-by-step transformation
-const ast = parse(pythonCode)
-const transformed = transform(ast)
-const { code, usedRuntimeFunctions } = generate(transformed, {
-  includeRuntime: true,
-  runtimeImportPath: "pythonlib"
-})
-```
-
-## Runtime Library
-
-python2ts uses [pythonlib](https://www.npmjs.com/package/pythonlib) for Python standard library
-functions:
-
-```typescript
-// Generated imports (grouped by module)
-import { range, enumerate, len } from "pythonlib"
-import { chain, combinations } from "pythonlib/itertools"
-import { Counter } from "pythonlib/collections"
-```
+**[📚 View Full Documentation](https://sebastian-software.github.io/python2ts/)**
 
-pythonlib is automatically included as a dependency.
-
-## Type Hints Preserved
-
-```python
-from typing import Optional, Callable, TypeVar
-
-T = TypeVar('T')
-
-def process(
-    items: list[T],
-    callback: Callable[[T, int], bool],
-    default: Optional[str] = None
-) -> dict[str, T]:
-    ...
-```
-
-Becomes:
-
-```typescript
-function process<T>(
-  items: T[],
-  callback: (arg0: T, arg1: number) => boolean,
-  default_: string | null = null
-): Record<string, T> {
-  // ...
-}
-```
+| Resource                                                                       | Description                                 |
+| ------------------------------------------------------------------------------ | ------------------------------------------- |
+| [Homepage](https://sebastian-software.github.io/python2ts/)                    | Project overview, features, and quick start |
+| [Getting Started](https://sebastian-software.github.io/python2ts/docs/)        | Installation and first steps                |
+| [Syntax Reference](https://sebastian-software.github.io/python2ts/docs/syntax) | Python → TypeScript transformation rules    |
+| [Runtime Library](https://sebastian-software.github.io/python2ts/docs/runtime) | Using pythonlib for Python standard library |
+| [API Reference](https://sebastian-software.github.io/python2ts/docs/api)       | Complete API documentation                  |
 
-## Requirements
+## Runtime Support
 
-- Node.js >= 22.0.0
+Tested on every commit: **Node.js** (v22, v24) · **Bun** · **Deno** · **Browsers**
 
 ## Related
 
-- [pythonlib](https://www.npmjs.com/package/pythonlib) — Python standard library for TypeScript
-  (standalone runtime)
+- [**pythonlib**](https://www.npmjs.com/package/pythonlib) — Python standard library for TypeScript
+- [**GitHub**](https://github.com/sebastian-software/python2ts) — Source code and issue tracker
 
 ## License
 
-MIT
+MIT © [Sebastian Software GmbH](https://sebastian-software.de)