JSON-Resume

Generate a polished DOCX resume from strict, structured JSON.

json-resume validates your resume data before rendering, applies a stable Word layout with explicit paper sizes, and provides both a command-line tool and Python APIs. It is designed for repeatable resume generation in local scripts, automation, and backend services.

Install

python -m pip install json-resume

The package installs its DOCX and PDF-related Python dependencies together. PDF export uses local Microsoft Word through docx2pdf.

Command line

Create a JSON resume, then generate a DOCX:

json-resume resume.json

By default, output is written to output/resume.docx under the current working directory. Common options:

json-resume resume.json -o resume.docx
json-resume resume.json --pdf
json-resume resume.json -o resume.docx --force

--pdf additionally writes a sibling PDF after DOCX generation. --force is required before replacing an existing DOCX or PDF.

Python API

Use the file-level API in scripts and automation:

from resume_generator import render_json_file_to_docx

output_path = render_json_file_to_docx(
    "resume.json",
    "resume.docx",
)

print(output_path)

Use the in-memory API in HTTP services or other integrations:

from resume_generator import render_json_to_docx

docx_bytes = render_json_to_docx(data)

Both APIs use the same strict validation and rendering core as the CLI. Validation failures raise FieldError with a precise JSON source path.

JSON contract

The top-level JSON object must contain exactly paper_size, basics, and sections.

{
  "paper_size": "Letter",
  "basics": {
    "name": "Example Candidate",
    "contacts": [
      {
        "label": "candidate@example.com",
        "href": "mailto:candidate@example.com"
      }
    ]
  },
  "sections": [
    {
      "title": "Experience",
      "entries": [
        {
          "title": "Example Organization",
          "position": "Analyst Intern",
          "location": "New York, NY",
          "start_date": "2025-06",
          "end_date": "Present",
          "bullets": [
            "Completed a fact-supported contribution."
          ]
        }
      ]
    }
  ]
}

Supported paper sizes are A4 and Letter. paper_size controls the Word page size only and does not translate content.

Read the full JSON contract, examples, and usage guide.

Project links

Project links

Data verified by PyPI on Aug 30, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for ericzhou_cn from gravatar.com ericzhou_cn

Credits

Author: Eric Zhou

GitHub Statistics

Data verified by PyPI on Aug 30, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

MIT
View SPDX License List

Requires

Python >=3.11

Tags

resume json docx word cv

Classifiers

Report project as malware

Download files

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

Source Distribution

json_resume-1.1.2.tar.gz (21.8 kB view details)

Uploaded Source

Built Distribution

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

json_resume-1.1.2-py3-none-any.whl (21.9 kB view details)

Uploaded Python 3

File details

Details for the file json_resume-1.1.2.tar.gz.

File metadata

  • Download URL: json_resume-1.1.2.tar.gz
  • Upload date:
  • Size: 21.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for json_resume-1.1.2.tar.gz
Algorithm Hash digest
SHA256 6bee194293aacdd371b3b0bdcf07367983a1a6be7334438745aa25f908c03013
MD5 b290f7ad893d8e37472a72dba35b76ab
BLAKE2b-256 1d10d48037123486d8483a0fedfc1193122c314d479349b0cb90c0d74055dedf

See more details on using hashes here.

Provenance

The following attestation bundles were made for json_resume-1.1.2.tar.gz:

Publisher: release.yml on Eric-Zhou-0302/JSON-Resume

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

File details

Details for the file json_resume-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: json_resume-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 21.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for json_resume-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ca338802422cdb2abbdffd76c8268bf26b011c7549095b86bcb9eb2a47f22729
MD5 5adc2da374753ea072e3c0cadc1f730f
BLAKE2b-256 b3a11db21638e2a4df869dec25567b022b9a1a9d91a294501db03c2ff1410c54

See more details on using hashes here.

Provenance

The following attestation bundles were made for json_resume-1.1.2-py3-none-any.whl:

Publisher: release.yml on Eric-Zhou-0302/JSON-Resume

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

Release history Release notifications | RSS feed

This release

1.1.2 This release

2 files

1.1.1

2 files

1.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page