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 locale-aware 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 locale, basics, and sections.

{
  "locale": "en-US",
  "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 locales are zh-CN, en-US, en-GB, and en-EU. en-US produces Letter paper; the others produce A4. Locale controls paper 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:
Newer release available (1.1.2)

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.1.tar.gz (22.1 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.1-py3-none-any.whl (22.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: json_resume-1.1.1.tar.gz
  • Upload date:
  • Size: 22.1 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.1.tar.gz
Algorithm Hash digest
SHA256 24bc44a862e2cfeda39a30fbced1edd07d2c93cc259a9d1c79e6e275dd902835
MD5 abdca870ab33e274c7bafebcbd07ee7a
BLAKE2b-256 0c48ee885d76bfbfef08fc7fec3dd0ee50ca823530c2f35c85b75484bc2bfa31

See more details on using hashes here.

Provenance

The following attestation bundles were made for json_resume-1.1.1.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.1-py3-none-any.whl.

File metadata

  • Download URL: json_resume-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 22.2 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4ee51e007a8c628ec524d47cddfcd479b57e262b5c20a0a782cdd498871bd8b1
MD5 3a0affd686a250a4fcc89927aa349847
BLAKE2b-256 106dcaaf537f91b2c498486c0e51e9e67af7ac9dd436019432a387b3bf8e1072

See more details on using hashes here.

Provenance

The following attestation bundles were made for json_resume-1.1.1-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

1.1.2

2 files

This release

1.1.1 This release

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