Skip to main content

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

Project description

GitHub Actions status Coverage PyPi Shield uv version Python Versions Shield License Shield

fastapi-resume

A thin wrapper around FastAPI to expose your CV as a JSON REST API

Usage

Install via pip

$ pip install fastapi-resume

Usage

$ 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 for a sample YAML file.

$ fast-resume serve templates/example.yaml

Then you can curl your new resume API:

$ curl http://localhost:8000/

Documentation

See docs for more real word examples and how to deploy to your favorite cloud provider (Coming soon)

Project details


Download files

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

Source Distribution

fastapi_resume-0.0.1.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

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

fastapi_resume-0.0.1-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

Details for the file fastapi_resume-0.0.1.tar.gz.

File metadata

  • Download URL: fastapi_resume-0.0.1.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for fastapi_resume-0.0.1.tar.gz
Algorithm Hash digest
SHA256 792e3377e1eeb23f82ae58b749fd5faff2a79d66b699b446435f84f7fd3bc707
MD5 09c8ceb7752b3274e790054418393b91
BLAKE2b-256 ca8d3e3f0145a826f51df1eb3c4bebf62e370b8cea266c823f24e602f0ce726e

See more details on using hashes here.

Provenance

The following attestation bundles were made for fastapi_resume-0.0.1.tar.gz:

Publisher: main.yaml on nickatnight/fastapi-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 fastapi_resume-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: fastapi_resume-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 7.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for fastapi_resume-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c5fadcfcef3f66ed53726e59e8410d33996cb660ec08eb0befd0336556e3976b
MD5 63dc15fdb141d69cee6f520b4ecde777
BLAKE2b-256 8be71b617ce2410011ff654e28a9ce125a2cd86ce63d3f089295191ad5c8e067

See more details on using hashes here.

Provenance

The following attestation bundles were made for fastapi_resume-0.0.1-py3-none-any.whl:

Publisher: main.yaml on nickatnight/fastapi-resume

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

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page