FastAPI / quotes
Quote PDFs in FastAPI
Post your quote HTML to a render API from an async endpoint returning StreamingResponse, then return StreamingResponse over the httpx byte iterator. No browser binary in your FastAPI deployment.
Why quotes become PDFs
A quote is an offer with an expiry, and it gets forwarded to people who will never log into your product. It has to stand alone and it has to be fixed at the moment it was sent. That is the difference between a document and a view of a database, and it is why sales teams keep asking for this.
What a quote has to carry
Before any of the code below matters, the template has to produce a document that is actually a quote. These are the fields that make it one, and the ones a reader or an auditor will look for first.
- a quote reference, which the eventual order will cite
- the validity date, after which the pricing no longer stands
- each line with the price offered, which may not be list price
- any discount shown as a discount rather than folded into the unit price
- the terms attached to the offer: payment schedule, lead time, exclusions
Turning your Jinja2Templates template into a document
You already have the markup. Templates.get_template("invoice.html").render(context) gives you it as a string, which is the only input the render needs. TemplateResponse is for returning HTML to a browser. When the HTML is going to a renderer you want the string, so call the underlying Jinja template directly rather than unwrapping a Response you never send.
The FastAPI implementation
httpx is the client most projects here already have. The render happens in an async endpoint returning StreamingResponse, and you return StreamingResponse over the httpx byte iterator.
# routers/quotes.py
import httpx
from fastapi import APIRouter, Depends
from fastapi.responses import StreamingResponse
from fastapi.templating import Jinja2Templates
router = APIRouter()
templates = Jinja2Templates(directory="templates")
@router.get("/quotes/{quote_id}.pdf")
async def quote_pdf(quote_id: int, db=Depends(get_db)):
quote = await db.get_quote(quote_id)
# The template directly, not TemplateResponse: we want the string, and
# TemplateResponse is for HTML you are actually sending to a browser.
html = templates.get_template("quote.html").render(quote=quote)
client = httpx.AsyncClient(timeout=60.0)
request = client.build_request(
"POST",
"https://api.pdfpipe.xyz/v1/pdf",
headers={"Authorization": f"Bearer {settings.pdfpipe_key}"},
json={"html": html, "options": {"format": "A4", "printBackground": True}},
)
upstream = await client.send(request, stream=True)
upstream.raise_for_status()
return StreamingResponse(
upstream.aiter_bytes(),
media_type="application/pdf",
background=BackgroundTask(upstream.aclose),
)The CSS that makes a quote page correctly
The layout problem specific to this document is that optional line items and discount blocks make the length unpredictable, so the signature area must not orphan onto a page of its own. These rules handle it.
/* Backgrounds are dropped unless printBackground is set on the
request, which is the usual reason a document renders in plain
black and white when it looked right in the browser. */
@page {
size: A4;
margin: 18mm 16mm;
}
table { break-inside: avoid; }
h2 { break-after: avoid; }What goes wrong in FastAPI
Calling a synchronous HTTP client inside an async def endpoint blocks the event loop for the whole render, which stalls every other request on that worker. Either use httpx.AsyncClient, or declare the endpoint def rather than async def so it runs in the threadpool.
What people try first
Most FastAPI projects reach for WeasyPrint called from a background task, which moves the memory cost off the request but not out of the process. That works until it is running on more than one machine, at which point the browser becomes the thing you operate rather than the thing you use.
Where the quote lives afterwards
Rendering is the short part. A quote is dead once it expires or converts, so retention is short and driven by the sales system rather than by law. What matters is that the version the customer received is the one you can produce later, because a disputed price is settled by the document that was sent.
Getting the document right
- Check the validity date, since a quote without one is an open-ended commitment.
- Generation is triggered by a salesperson sending it, so latency is felt directly by a person waiting, so size the timeout for that path rather than for a health check.
- These are produced one at a time by a person who is waiting, so latency is felt directly.
- Backgrounds are painted by default here, so a design that uses colour needs nothing set. Only an explicit print_background of false turns them off.
Frequently asked
Do I need Chromium installed to generate quotes from FastAPI?
No. The render happens over HTTP, so your FastAPI deployment stays the size it is now. That is the main reason to use an API rather than WeasyPrint called from a background task, which moves the memory cost off the request but not out of the process.
How do I stop a long quote using all the memory?
Return StreamingResponse over the httpx byte iterator. Calling a synchronous HTTP client inside an async def endpoint blocks the event loop for the whole render, which stalls every other request on that worker. Either use httpx.AsyncClient, or declare the endpoint def rather than async def so it runs in the threadpool.
What has to be on a quote?
At minimum: a quote reference, which the eventual order will cite; the validity date, after which the pricing no longer stands; each line with the price offered, which may not be list price. The one to get right before anything else is the validity date, since a quote without one is an open-ended commitment.
Do I need to store the generated quotes?
Depends on the document, and this one has a clear answer: a quote is dead once it expires or converts, so retention is short and driven by the sales system rather than by law. What matters is that the version the customer received is the one you can produce later, because a disputed price is settled by the document that was sent.
Can I keep my existing quote template?
Yes, if it produces HTML. Whatever renders your quote view today can render the same markup for the PDF, which is why the CSS above is the only new thing you write.
Related
Other FastAPI documents, and the same quote in other stacks.
Invoice PDFs in FastAPI
an invoice is a legal record of a demand for payment
Receipt PDFs in FastAPI
a receipt is proof a payment happened
Report PDFs in FastAPI
a report is a snapshot of numbers at a moment in time. Its whole value is that it does not change when the underlying dashboard does.
Quote PDFs in Node.js
Using fetch, in a route handler that returns the response body directly.
Quote PDFs in Python
Using httpx, in an async endpoint that returns a streaming response.
Quote PDFs in PHP
Using cURL, in a controller action that echoes the body with a PDF Content-Type.
The same thing in plain Python
Without the framework, using httpx directly.
When the output is wrong
Blank pages, missing backgrounds, breaks in the wrong place, by symptom.
All stacks and documents
The full grid of what this covers.
100 free documents a month, no card.