Metadata-Version: 2.4
Name: json-to-schema
Version: 1.3.0
Summary: A tool to infer JSON Schemas from JSON data.
Author: Isak Lindgren
License: MIT License
        
        Copyright (c) 2026 Isak Lindgren
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/isalin/json-to-schema
Project-URL: Repository, https://github.com/isalin/json-to-schema
Project-URL: Issues, https://github.com/isalin/json-to-schema/issues
Project-URL: Changelog, https://github.com/isalin/json-to-schema/releases
Keywords: json,json-schema,schema,generator,inference,cli,draft-2020-12,schema-generator,json-schema-inference
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# json-to-schema

[![Build](https://img.shields.io/github/actions/workflow/status/isalin/json-to-schema/publish.yml)](https://github.com/isalin/json-to-schema/actions/workflows/publish.yml)
[![PyPI version](https://img.shields.io/pypi/v/json-to-schema.svg)](https://pypi.org/project/json-to-schema/)
[![Python versions](https://img.shields.io/pypi/pyversions/json-to-schema.svg)](https://pypi.org/project/json-to-schema/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

`json-to-schema` is a Python tool that infers a JSON Schema from JSON data.
Use it to generate JSON Schema definitions quickly from real payloads.
It outputs schemas compatible with [JSON Schema draft 2020-12](https://json-schema.org/draft/2020-12).

## Features

- Infers types for objects, arrays, and scalars.
- Merges array item types across elements.
- Marks object properties as required based on the input instance.
- Optionally infers bounds for selected fields with `--infer-bounds`.
- Optionally infers enum values for selected fields with `--infer-enum`.
- Supports global inference with `--infer-all-bounds` and `--infer-all-enum`.
- Sets root schema metadata with `--schema-id`, `--schema-title`, and `--schema-description`.
- Sets field-level metadata with `--field-title` and `--field-description`.
- Validates input JSON against a provided schema file with `--validate`.
- Emits schemas compliant with JSON Schema draft 2020-12.

## Requirements

- Python 3.8+

## Install

```bash
pip install json-to-schema
```

## Generate JSON Schema from a JSON file (CLI)

Provide an input JSON file (defaults to `file.json`) and print the inferred schema to stdout:

```bash
json-to-schema
```

Specify a custom input file and write output to a schema file:

```bash
json-to-schema -i input.json -o schema.json
```

Print compact/minified output:

```bash
json-to-schema -i input.json --minify
```

Infer bounds:

```bash
json-to-schema -i input.json --infer-bounds age price tags
```

Infer enum values:

```bash
json-to-schema -i input.json --infer-enum status type
```

Infer bounds for all applicable fields:

```bash
json-to-schema -i input.json --infer-all-bounds
```

Infer enum values for all applicable fields:

```bash
json-to-schema -i input.json --infer-all-enum
```

Set root schema metadata:

```bash
json-to-schema -i input.json \
  --schema-id https://example.com/schemas/product \
  --schema-title "Product Schema" \
  --schema-description "Schema for product payloads"
```

Set field-level metadata (dot paths, with `[]` for array items):

```bash
json-to-schema -i input.json \
  --field-title user.name="Full name" \
  --field-description tags[]="Tag value"
```

Validate a payload file against an existing schema:

```bash
json-to-schema -i payload.json --validate schema.json
```

Validate piped stdin against a schema:

```bash
echo '{"name":"Widget","price":12.5}' | json-to-schema --validate schema.json
```

You can also pipe JSON directly into stdin:

```bash
echo '{"name":"Widget","price":12.5}' | json-to-schema
```

## Infer JSON Schema in Python code (library usage)

You can also import and use this package directly in Python applications:

```python
import json
from json_to_schema import infer_schema, SCHEMA_DRAFT

data = {
  "name": "Widget",
  "price": 12.5,
  "tags": ["sale", "featured"],
  "in_stock": True
}

schema = {
  "$schema": SCHEMA_DRAFT,
  **infer_schema(data)
}

print(json.dumps(schema, indent=2))
```

## Example: convert sample JSON to schema

Input (`input.json`):

```json
{
  "name": "Widget",
  "price": 12.5,
  "tags": ["sale", "featured"],
  "in_stock": true
}
```

Run:

```bash
json-to-schema -i input.json -o schema.json
```

Output (`schema.json`):

```json
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": { "type": "string" },
    "price": { "type": "number" },
    "tags": {
      "type": "array",
      "items": { "type": "string" }
    },
    "in_stock": { "type": "boolean" }
  },
  "required": ["in_stock", "name", "price", "tags"],
  "additionalProperties": false
}
```

## Testing

```bash
python -m pip install -e .
python -m unittest discover -s tests
```
