# resume-pycli
CLI tool to build a beautiful resume from a [JSON
Resume](https://jsonresume.org/) file.
This is a Python port of
[resume-cli](https://github.com/jsonresume/resume-cli).
[](https://libraries.io/pypi/resume-pycli)
[](https://pypi.org/project/resume-pycli/)
## Features
* Validate your `resume.json` against schema
* Export your resume to HTML
* Export your resume to PDF
* Customize the theme of your HTML and PDF exports
* Run a local HTTP server to preview the HTML export
* Create an inital `resume.json` with placeholder values to get started
## Installation
With [pipx](https://pipxproject.github.io/pipx/):
```
pipx install resume-pycli
```
## Usage
```
Usage: resume [OPTIONS] COMMAND [ARGS]...
CLI tool to easily setup a new resume.
Options:
--help Show this message and exit.
Commands:
export Export to HTML and PDF.
init Initialize a resume.json file.
serve Serve resume.
validate Validate resume's schema.
version Show application version.
```
Export your resume with a custom theme, for exemple one located in
`./themes/my-beautiful-theme`:
```
resume export --theme my-beautiful-theme
```
If you want to export custom version of your resume, for example a shorter one
located at `./resume.short.json`, to PDF only:
```
resume export --resume resume.short.json --pdf
```
## Themes
You can put your theme in `themes/<name>` next to your `resume.json` file. It
uses [Jinja](https://jinja.palletsprojects.com/en/3.0.x/) as templating engine.
Take a look at the [included
themes](https://github.com/nikaro/resume-pycli/tree/main/resume_pycli/themes/base)
that you can take as example to write your own.
Since it uses Jinja, it is not compatible with ["official" community
themes](https://jsonresume.org/themes/).
Raw data
{
"_id": null,
"home_page": "https://github.com/nikaro/resume-pycli",
"name": "resume-pycli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9,<4.0",
"maintainer_email": "",
"keywords": "resume,json,cli",
"author": "Nicolas Karolak",
"author_email": "nicolas@karolak.fr",
"download_url": "https://files.pythonhosted.org/packages/cb/ac/6d763b7d9077436e99cf187fff7b484533db87af0dac5780502b28cb8be5/resume_pycli-4.0.0.tar.gz",
"platform": null,
"description": "# resume-pycli\n\nCLI tool to build a beautiful resume from a [JSON\nResume](https://jsonresume.org/) file.\n\nThis is a Python port of\n[resume-cli](https://github.com/jsonresume/resume-cli).\n\n[](https://libraries.io/pypi/resume-pycli)\n[](https://pypi.org/project/resume-pycli/)\n\n## Features\n\n* Validate your `resume.json` against schema\n* Export your resume to HTML\n* Export your resume to PDF\n* Customize the theme of your HTML and PDF exports\n* Run a local HTTP server to preview the HTML export\n* Create an inital `resume.json` with placeholder values to get started\n\n## Installation\n\nWith [pipx](https://pipxproject.github.io/pipx/):\n\n```\npipx install resume-pycli\n```\n\n## Usage\n\n```\nUsage: resume [OPTIONS] COMMAND [ARGS]...\n\n CLI tool to easily setup a new resume.\n\nOptions:\n --help Show this message and exit.\n\nCommands:\n export Export to HTML and PDF.\n init Initialize a resume.json file.\n serve Serve resume.\n validate Validate resume's schema.\n version Show application version.\n```\n\nExport your resume with a custom theme, for exemple one located in\n`./themes/my-beautiful-theme`:\n\n```\nresume export --theme my-beautiful-theme\n```\n\nIf you want to export custom version of your resume, for example a shorter one\nlocated at `./resume.short.json`, to PDF only:\n\n```\nresume export --resume resume.short.json --pdf\n```\n\n## Themes\n\nYou can put your theme in `themes/<name>` next to your `resume.json` file. It\nuses [Jinja](https://jinja.palletsprojects.com/en/3.0.x/) as templating engine.\nTake a look at the [included\nthemes](https://github.com/nikaro/resume-pycli/tree/main/resume_pycli/themes/base)\nthat you can take as example to write your own.\n\nSince it uses Jinja, it is not compatible with [\"official\" community\nthemes](https://jsonresume.org/themes/).\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "CLI tool to easily setup a new resume",
"version": "4.0.0",
"split_keywords": [
"resume",
"json",
"cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cc53f1c3deff2b3409bf4f4a8c22cca2d3661e871d15ad4c020b5f28d78e5eaa",
"md5": "c396f800ccdd8898a5a66d0cadc6f95b",
"sha256": "edfdc15332df31189a631efc6517a53f7f4755ed9ca341f4088006e06db09d06"
},
"downloads": -1,
"filename": "resume_pycli-4.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c396f800ccdd8898a5a66d0cadc6f95b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9,<4.0",
"size": 1976704,
"upload_time": "2023-01-31T23:14:14",
"upload_time_iso_8601": "2023-01-31T23:14:14.020919Z",
"url": "https://files.pythonhosted.org/packages/cc/53/f1c3deff2b3409bf4f4a8c22cca2d3661e871d15ad4c020b5f28d78e5eaa/resume_pycli-4.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cbac6d763b7d9077436e99cf187fff7b484533db87af0dac5780502b28cb8be5",
"md5": "3dfc3635513368b4416f08651f608669",
"sha256": "7dbc13a89611a0824ad5ef69232a559f499b4ae1f8614ba4e3c750d981333b8a"
},
"downloads": -1,
"filename": "resume_pycli-4.0.0.tar.gz",
"has_sig": false,
"md5_digest": "3dfc3635513368b4416f08651f608669",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9,<4.0",
"size": 1973322,
"upload_time": "2023-01-31T23:14:15",
"upload_time_iso_8601": "2023-01-31T23:14:15.733945Z",
"url": "https://files.pythonhosted.org/packages/cb/ac/6d763b7d9077436e99cf187fff7b484533db87af0dac5780502b28cb8be5/resume_pycli-4.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-31 23:14:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "nikaro",
"github_project": "resume-pycli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "resume-pycli"
}
JSON
