An open API service indexing awesome lists of open source software.

https://github.com/nickatnight/fastapi-resume

:dizzy: FastAPI-powered resume generator: expose your CV as a JSON REST API
https://github.com/nickatnight/fastapi-resume

codecov fastapi pre-commit python resume-generator resume-template typer uv

Last synced: 3 months ago
JSON representation

:dizzy: FastAPI-powered resume generator: expose your CV as a JSON REST API

Awesome Lists containing this project

README

          



GitHub Actions status


Coverage


PyPi Shield


uv version


Python Versions Shield

Read The Docs Badge

License Shield

# 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
```

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/)