python-typewriter

Usage

Core CLI patterns

Use check mode for review, CI, and bots:

typewriter run . --check --respect-gitignore

Use apply mode for local cleanup:

typewriter run . --respect-gitignore

When a directory is scanned, Typewriter ignores non-.py files and common non-source directories such as .git, .venv, venv, __pycache__, build, and dist.

JSON output for automation

If another tool needs structured output, use JSON:

typewriter run . --check --respect-gitignore --output-format json

Directory and file runs report the scanned path, whether check mode was used, how many files were processed, how many changed, and optional unified diffs. --code runs report whether the input changed and return either the transformed code or the diff, depending on the mode.

CI example

A minimal GitHub Actions step looks like:

- name: Check None-related typing annotations
  run: typewriter run . --check --respect-gitignore

pre-commit example

Typewriter accepts a single path per invocation, so a local hook that scans the repository root is the simplest setup:

repos:
  - repo: local
    hooks:
      - id: typewriter
        name: typewriter
        entry: typewriter run .
        language: system
        pass_filenames: false

That local hook pairs well with a CI --check run so contributors see the same normalization rules locally and in pull requests.

This site is open source. Improve this page.