foolscap-sdk
SDK Python oficial do Foolscap — geração de documentos: template + JSON → PDF, direto da sua aplicação.
pip install foolscap-sdk
from foolscap_sdk import Foolscap
client = Foolscap(api_key="fsk_...") # crie a key no painel, seção API Keys
doc = client.render(
template_id="tpl_...",
data={"contratante": {"nome": "Maria Silva"}},
document_name="Contrato — Maria Silva",
)
print(doc.pdf_url) # PDF pronto, URL assinada
render() cuida do ciclo assíncrono inteiro (a API responde 202 e o SDK acompanha
até o documento ficar pronto — segundos). Retry de rede é seguro por padrão: todo
render envia uma chave de idempotência, então reenvio nunca duplica documento.
Controle fino
accepted = client.render_nowait(template_id="tpl_...", data={...})
# ... sua fila, seu ritmo ...
doc = client.wait_for_document(accepted.document_id) # ou get_document(), 1 consulta seca
pdf_bytes = client.download_pdf(doc.id)
Descoberta e histórico
for template in client.list_templates():
print(template.id, template.name, template.sample_data) # sample_data = contrato do `data`
for doc in client.iter_documents(): # paginação automática
print(doc.created_at, doc.name, doc.status)
conta = client.account()
print(conta.plan, conta.usage.documents, "/", conta.usage.limit)
Erros
Tudo herda de FoolscapError:
from foolscap_sdk import FoolscapError, QuotaExceededError, TemplateRenderError
try:
doc = client.render(template_id="tpl_...", data=dados)
except TemplateRenderError as e:
print("variável faltando ou template inválido:", e.detail)
except QuotaExceededError:
print("cota do mês esgotada — hora do upgrade :)")
except FoolscapError as e:
print("qualquer outra falha do SDK/API:", e)
Referências
- Guia de integração: https://foolscap.app.br/guia
- Referência completa da API: https://api.foolscap.app.br/docs
Python ≥ 3.10 · tipagem completa · dependência única (httpx2) · MIT
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file foolscap_sdk-0.1.0.tar.gz.
File metadata
- Download URL: foolscap_sdk-0.1.0.tar.gz
- Upload date:
- Size: 22.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.12.2 {"installer":{"name":"uv","version":"0.12.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9bfb36f2e5ba23da79c085e221e0b336bca6c65ac38f6a0eab2d6340e110e6ea
|
|
| MD5 |
26253a65db8a33846ad54133432c9b71
|
|
| BLAKE2b-256 |
e6eb846c424f4b6e744f2faa467a4e297efd6fcd195455dd3fe7d323e699cbc8
|
File details
Details for the file foolscap_sdk-0.1.0-py3-none-any.whl.
File metadata
- Download URL: foolscap_sdk-0.1.0-py3-none-any.whl
- Upload date:
- Size: 9.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.12.2 {"installer":{"name":"uv","version":"0.12.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3ac553fc407bb418a99d1a9c112d3c420126cef46b32d47257ef82ec3ac721ff
|
|
| MD5 |
554844385b42961080a28e836a0bade4
|
|
| BLAKE2b-256 |
4f9d09de0a3b29e844e72bd0d7ff4c22e5ba67e710935fe98125997c6f5c9c56
|