<p align="center">
<a href="https://github.com/nickatnight/fastapi-resume/actions">
<img alt="GitHub Actions status" src="https://github.com/nickatnight/fastapi-resume/actions/workflows/main.yaml/badge.svg">
</a>
<a href="https://codecov.io/gh/nickatnight/fastapi-resume">
<img alt="Coverage" src="https://codecov.io/gh/nickatnight/fastapi-resume/branch/main/graph/badge.svg?token=5yV0ottQ9o"/>
</a>
<a href="https://pypi.org/project/fastapi-resume/">
<img alt="PyPi Shield" src="https://img.shields.io/pypi/v/fastapi-resume">
</a>
<a href="https://docs.astral.sh/uv/">
<img alt="uv version" src="https://img.shields.io/badge/uv-0.7.18+-purple">
</a>
<a href="https://www.python.org/downloads/">
<img alt="Python Versions Shield" src="https://img.shields.io/badge/Python-3.12+-blue?logo=python&logoColor=white">
</a>
<a href="https://fastapi-resume.readthedocs.io/en/latest/"><img alt="Read The Docs Badge" src="https://img.shields.io/readthedocs/fastapi-resume"></a>
<a href="https://github.com/nickatnight/fastapi-resume/blob/master/LICENSE">
<img alt="License Shield" src="https://img.shields.io/github/license/nickatnight/fastapi-resume">
</a>
</p>
# fastapi-resume
A thin wrapper around FastAPI to expose your CV as a JSON REST API
## Usage
Install via pip
```sh
$ pip install fastapi-resume
```
## Usage
```sh
$ fast-resume --help
Usage: fast-resume [OPTIONS] COMMAND [ARGS]...
FastAPI Resume API Server
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ serve Start the FastAPI Resume API server. │
│ validate Validate a YAML data file without starting the server. │
│ info Display information about the resume data without starting the server. │
╰───
```
### Basic (local)
See the [example](./fastapi_resume/templates/example.yaml) for a sample YAML file
```sh
$ fast-resume serve <resume.yaml>
```
Then you can `curl` your new resume API:
```sh
$ curl http://localhost:8000/
```
## Documentation
See docs for more real word examples and how to deploy to your favorite cloud provider [here](https://fastapi-resume.readthedocs.io/en/latest/)
Raw data
{
"_id": null,
"home_page": null,
"name": "fastapi-resume",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": "Nick Kelly <nialexanderke@proton.me>",
"keywords": "Python, resume, project directory, package, packaging, FastAPI, Typer, CLI",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/9d/fc/1003d546ba1f37ee92d82b0e35de7acb31ea06b844dff46ff5ea0e1e4663/fastapi_resume-0.0.3.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <a href=\"https://github.com/nickatnight/fastapi-resume/actions\">\n <img alt=\"GitHub Actions status\" src=\"https://github.com/nickatnight/fastapi-resume/actions/workflows/main.yaml/badge.svg\">\n </a>\n <a href=\"https://codecov.io/gh/nickatnight/fastapi-resume\">\n <img alt=\"Coverage\" src=\"https://codecov.io/gh/nickatnight/fastapi-resume/branch/main/graph/badge.svg?token=5yV0ottQ9o\"/>\n </a>\n <a href=\"https://pypi.org/project/fastapi-resume/\">\n <img alt=\"PyPi Shield\" src=\"https://img.shields.io/pypi/v/fastapi-resume\">\n </a>\n <a href=\"https://docs.astral.sh/uv/\">\n <img alt=\"uv version\" src=\"https://img.shields.io/badge/uv-0.7.18+-purple\">\n </a>\n <a href=\"https://www.python.org/downloads/\">\n <img alt=\"Python Versions Shield\" src=\"https://img.shields.io/badge/Python-3.12+-blue?logo=python&logoColor=white\">\n </a>\n <a href=\"https://fastapi-resume.readthedocs.io/en/latest/\"><img alt=\"Read The Docs Badge\" src=\"https://img.shields.io/readthedocs/fastapi-resume\"></a>\n <a href=\"https://github.com/nickatnight/fastapi-resume/blob/master/LICENSE\">\n <img alt=\"License Shield\" src=\"https://img.shields.io/github/license/nickatnight/fastapi-resume\">\n </a>\n</p>\n\n# fastapi-resume\n\nA thin wrapper around FastAPI to expose your CV as a JSON REST API\n\n## Usage\n\nInstall via pip\n\n```sh\n$ pip install fastapi-resume\n```\n\n## Usage\n\n```sh\n$ fast-resume --help\nUsage: fast-resume [OPTIONS] COMMAND [ARGS]...\n\n FastAPI Resume API Server\n\n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 serve Start the FastAPI Resume API server. \u2502\n\u2502 validate Validate a YAML data file without starting the server. \u2502\n\u2502 info Display information about the resume data without starting the server. \u2502\n\u2570\u2500\u2500\u2500\n```\n\n### Basic (local)\nSee the [example](./fastapi_resume/templates/example.yaml) for a sample YAML file\n\n```sh\n$ fast-resume serve <resume.yaml>\n```\n\nThen you can `curl` your new resume API:\n\n```sh\n$ curl http://localhost:8000/\n```\n\n## Documentation\nSee docs for more real word examples and how to deploy to your favorite cloud provider [here](https://fastapi-resume.readthedocs.io/en/latest/)\n",
"bugtrack_url": null,
"license": null,
"summary": "FastAPI-powered resume generator: expose your CV as a JSON REST API",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/nickatnight/fastapi-resume",
"Issues": "https://github.com/nickatnight/fastapi-resume/issues"
},
"split_keywords": [
"python",
" resume",
" project directory",
" package",
" packaging",
" fastapi",
" typer",
" cli"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "ac915c70232b071245bc4ca103e2d99648a3930241b59a1e59be7e54e00bbbf9",
"md5": "8dbee3cdfff7a025bb3e6458fb7ab4fe",
"sha256": "b498f70987597bcbc104b943a3e776161bef40a4a469e40b79b1848a4776be89"
},
"downloads": -1,
"filename": "fastapi_resume-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8dbee3cdfff7a025bb3e6458fb7ab4fe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 11784,
"upload_time": "2025-07-24T06:52:51",
"upload_time_iso_8601": "2025-07-24T06:52:51.455335Z",
"url": "https://files.pythonhosted.org/packages/ac/91/5c70232b071245bc4ca103e2d99648a3930241b59a1e59be7e54e00bbbf9/fastapi_resume-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9dfc1003d546ba1f37ee92d82b0e35de7acb31ea06b844dff46ff5ea0e1e4663",
"md5": "2993a3afe6b4d86f79a89647732cdab1",
"sha256": "a0f089166a7f2a70d036ea182a198e4a673e5417ce1e4cffdaf5b42938142cf9"
},
"downloads": -1,
"filename": "fastapi_resume-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "2993a3afe6b4d86f79a89647732cdab1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 9426,
"upload_time": "2025-07-24T06:52:52",
"upload_time_iso_8601": "2025-07-24T06:52:52.778845Z",
"url": "https://files.pythonhosted.org/packages/9d/fc/1003d546ba1f37ee92d82b0e35de7acb31ea06b844dff46ff5ea0e1e4663/fastapi_resume-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-24 06:52:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nickatnight",
"github_project": "fastapi-resume",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "fastapi-resume"
}
JSON
