Datamodel Code Generator

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for gaborbernat from gravatar.com gaborbernat Avatar for koxudaxi from gravatar.com koxudaxi
Meta

Unverified details

These details have not been verified by PyPI
Meta
  • License Expression: MIT
    SPDX License Expression
  • Requires: Python >=3.10
  • Provides-Extra: all , debug , graphql , http , ruff , ryaml , validation , watch
Classifiers
Report project as malware

Project description

datamodel-code-generator

๐Ÿš€ Generate Python data models from schema definitions in seconds.

PyPI version Conda-forge Downloads PyPI - Python Version codecov license Pydantic v2

๐Ÿ“ฃ ๐Ÿ’ผ Maintainer update: Open to opportunities. ๐Ÿ”— koxudaxi.dev

โœจ What it does

  • ๐Ÿ“„ Converts OpenAPI 3, JSON Schema, GraphQL, and raw data (JSON/YAML/CSV) into Python models
  • ๐Ÿ Generates from existing Python types (Pydantic, dataclass, TypedDict) via --input-model
  • ๐ŸŽฏ Generates Pydantic v2, Pydantic v2 dataclass, dataclasses, TypedDict, or msgspec output
  • ๐Ÿ”— Handles complex schemas: $ref, allOf, oneOf, anyOf, enums, and nested types
  • โœ… Produces type-safe, validated code ready for your IDE and type checker

๐Ÿ“– Documentation

๐Ÿ‘‰ datamodel-code-generator.koxudaxi.dev

๐Ÿ“ฆ Installation

uv tool install datamodel-code-generator
Other installation methods

pip:

pip install datamodel-code-generator

uv (add to project):

uv add datamodel-code-generator

conda:

conda install -c conda-forge datamodel-code-generator

With HTTP support (for resolving remote $ref):

pip install 'datamodel-code-generator[http]'

With GraphQL support:

pip install 'datamodel-code-generator[graphql]'

Docker:

docker pull koxudaxi/datamodel-code-generator

๐Ÿƒ Quick Start

datamodel-codegen --input schema.json --input-file-type jsonschema --output-model-type pydantic_v2.BaseModel --output model.py
๐Ÿ“„ schema.json (input) 
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Pet",
  "type": "object",
  "required": ["name", "species"],
  "properties": {
    "name": {
      "type": "string",
      "description": "The pet's name"
    },
    "species": {
      "type": "string",
      "enum": ["dog", "cat", "bird", "fish"]
    },
    "age": {
      "type": "integer",
      "minimum": 0,
      "description": "Age in years"
    },
    "vaccinated": {
      "type": "boolean",
      "default": false
    }
  }
}
๐Ÿ model.py (output) 
# generated by datamodel-codegen:
#   filename:  schema.json

from __future__ import annotations

from enum import Enum
from typing import Optional

from pydantic import BaseModel, Field


class Species(Enum):
    dog = 'dog'
    cat = 'cat'
    bird = 'bird'
    fish = 'fish'


class Pet(BaseModel):
    name: str = Field(..., description="The pet's name")
    species: Species
    age: Optional[int] = Field(None, description='Age in years', ge=0)
    vaccinated: Optional[bool] = False

๐Ÿ“ฅ Supported Input

  • OpenAPI 3 (YAML/JSON)
  • JSON Schema
  • JSON / YAML / CSV data
  • GraphQL schema
  • Python types (Pydantic, dataclass, TypedDict) via --input-model
  • Python dictionary

๐Ÿ“ค Supported Output

๐Ÿณ Common Recipes

๐Ÿค– Get CLI Help from LLMs

Generate a prompt to ask LLMs about CLI options:

datamodel-codegen --generate-prompt "Best options for Pydantic v2?" | claude -p

See LLM Integration for more examples.

๐ŸŒ Generate from URL

pip install 'datamodel-code-generator[http]'
datamodel-codegen --url https://example.com/api/openapi.yaml --output model.py

โš™๏ธ Use with pyproject.toml

[tool.datamodel-codegen]
input = "schema.yaml"
output = "src/models.py"
output-model-type = "pydantic_v2.BaseModel"

Then simply run:

datamodel-codegen

See pyproject.toml Configuration for more options.

๐Ÿ”„ CI/CD Integration

Validate generated models in your CI pipeline:

- uses: koxudaxi/datamodel-code-generator@0.44.0
  with:
    input: schemas/api.yaml
    output: src/models/api.py

See CI/CD Integration for more options.

๐Ÿ’– Sponsors

Astral Logo

Astral

๐Ÿข Projects that use datamodel-code-generator

These projects use datamodel-code-generator. See the linked examples for real-world usage.

See all dependents โ†’

๐Ÿ”— Related Projects

๐Ÿค Contributing

See Development & Contributing for how to get started!

๐Ÿ“„ License

MIT License - see LICENSE for details.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for gaborbernat from gravatar.com gaborbernat Avatar for koxudaxi from gravatar.com koxudaxi
Meta

Unverified details

These details have not been verified by PyPI
Meta
  • License Expression: MIT
    SPDX License Expression
  • Requires: Python >=3.10
  • Provides-Extra: all , debug , graphql , http , ruff , ryaml , validation , watch
Classifiers

Release history Release notifications | RSS feed

This version

0.57.0

0.56.1

0.56.0

0.55.0

0.54.1

0.54.0

0.53.0

0.52.2

0.52.1

0.52.0

0.51.0

0.50.0

0.49.0

0.48.0

0.47.0

0.46.0

0.45.0

0.44.0

0.43.1

0.43.0

0.42.2

0.42.1

0.42.0

0.41.0

0.40.0

0.39.0

0.38.0 yanked

Reason this release was yanked:

The --use-all-exports option is being redesigned. Please use version 0.37.0 until 0.39.0 is released.

0.37.0

0.36.0

0.35.0

0.34.0

0.33.0

0.32.0

0.31.2

0.31.1

0.31.0

0.30.2

0.30.1

0.30.0

0.29.0

0.28.5

0.28.4

0.28.3

0.28.2

0.28.1

0.28.0

0.27.3

0.27.2

0.27.1

0.27.0

0.26.5

0.26.4

0.26.3

0.26.2

0.26.1

0.26.0

0.25.9

0.25.8

0.25.7

0.25.6

0.25.5

0.25.4

0.25.3

0.25.2

0.25.1

0.25.0

0.24.2

0.24.1

0.24.0

0.23.0

0.22.1

0.22.0

0.21.5

0.21.4

0.21.3

0.21.2

0.21.1

0.21.0

0.20.0

0.19.0

0.18.1

0.18.0

0.17.2

0.17.1

0.17.0

0.16.1

0.16.0

0.15.0

0.14.1

0.14.0

0.13.5

0.13.4

0.13.3

0.13.2

0.13.1

0.13.0

0.12.3

0.12.2

0.12.1

0.12.0

0.11.20

0.11.19

0.11.18

0.11.17

0.11.16

0.11.15

0.11.14

0.11.13

0.11.12

0.11.11

0.11.10

0.11.9

0.11.8

0.11.7

0.11.6

0.11.5

0.11.4

0.11.3

0.11.2

0.11.1

0.11.0

0.10.3

0.10.2

0.10.1

0.10.0

0.9.4

0.9.3

0.9.2

0.9.1

0.9.0

0.8.3

0.8.2

0.8.1

0.8.0

0.7.3

0.7.2

0.7.1

0.7.0

0.6.26

0.6.25

0.6.24

0.6.23

0.6.22

0.6.21

0.6.20

0.6.19

0.6.18

0.6.17

0.6.16

0.6.15

0.6.14

0.6.13

0.6.12

0.6.11

0.6.10

0.6.9

0.6.8

0.6.7

0.6.6

0.6.5

0.6.4

0.6.3

0.6.2

0.6.1

0.6.0

0.5.39

0.5.38

0.5.37

0.5.36

0.5.35

0.5.34

0.5.33

0.5.32

0.5.31

0.5.30

0.5.29

0.5.28

0.5.27

0.5.26

0.5.25

0.5.24

0.5.23

0.5.22

0.5.21

0.5.20

0.5.19

0.5.18

0.5.17

0.5.16

0.5.15

0.5.14

0.5.13

0.5.12

0.5.11

0.5.10

0.5.9

0.5.8

0.5.7

0.5.6

0.5.5

0.5.4

0.5.3

0.5.2

0.5.1

0.5.0

0.4.11

0.4.10

0.4.9

0.4.8

0.4.7

0.4.6

0.4.5

0.4.4

0.4.3

0.4.2

0.4.1

0.4.0

0.3.3

0.3.2

0.3.1

0.3.0

0.2.16

0.2.15

0.2.14

0.2.13

0.2.12

0.2.11

0.2.10

0.2.9

0.2.8

0.2.7

0.2.6

0.2.5

0.2.4

0.2.3

0.2.2

0.2.1

0.2.0

0.1.0

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

0.0.1

Download files

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

Source Distribution

datamodel_code_generator-0.57.0.tar.gz (932.9 kB view details)

Uploaded Source

Built Distribution

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

datamodel_code_generator-0.57.0-py3-none-any.whl (259.3 kB view details)

Uploaded Python 3

File details

Details for the file datamodel_code_generator-0.57.0.tar.gz.

File metadata

File hashes

Hashes for datamodel_code_generator-0.57.0.tar.gz
Algorithm Hash digest
SHA256 0eda778ea06eaa476e542a5f1fe1d14cc3bbf686edb33a0ad6151c7d19089906
MD5 55074a583491266fca485d836907a228
BLAKE2b-256 5d4487d5980f813a1e323c5d726b3ac5fec8c915ce8a77fcdceaf9c00457dbae

See more details on using hashes here.

Provenance

The following attestation bundles were made for datamodel_code_generator-0.57.0.tar.gz:

Publisher: publish.yaml on koxudaxi/datamodel-code-generator

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

File details

Details for the file datamodel_code_generator-0.57.0-py3-none-any.whl.

File metadata

File hashes

Hashes for datamodel_code_generator-0.57.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d26bf5defe5154493d0aa5a822b7725332b9e9dd2abccc2f8856052286aa83b5
MD5 9d41e8f976d4744f98a28700e5f8bd24
BLAKE2b-256 c5c14fb9a44bb4a305b860c5a5b1866dcccfac3b76f5f170a9e68fc7733e16d2

See more details on using hashes here.

Provenance

The following attestation bundles were made for datamodel_code_generator-0.57.0-py3-none-any.whl:

Publisher: publish.yaml on koxudaxi/datamodel-code-generator

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

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