Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
160 changes: 160 additions & 0 deletions python/generate-pdf/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
34 changes: 34 additions & 0 deletions python/generate-pdf/Readme.md
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please rename this file to README.md

Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# 📄 Python Generate PDF Function

Document containing a sample invoice in PDF format.

## 🧰 Usage

### GET /

Returns a PDF invoice.

No parameters required.

**Response**

Sample `200` Response:

- Returns a binary stream of the generated PDF document.
- The `Content-Type` of the response will be set as `application/pdf`.

## ⚙️ Configuration

| Setting | Value |
| ----------------- | --------------------- |
| Runtime | Python (3.8 or later) |
| Entrypoint | `src/main.py` |
| Build Commands | `pip install -r requirements.txt` |
| Permissions | `any` |
| Timeout (Seconds) | 15 |

## 🔒 Environment Variables

No environment variables required.

> Note: Ensure you have a `requirements.txt` file in the project directory containing all the necessary packages (like `Faker`, `pdfkit`, etc.).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we provide this we don't need this line :)

2 changes: 2 additions & 0 deletions python/generate-pdf/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Faker
pdfkit
24 changes: 24 additions & 0 deletions python/generate-pdf/src/faker.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
from faker import Faker
import random

fake = Faker()

def generate_fake_order():
items_count = random.randint(1, 5)
items = [
{
"description": fake.product_name(),
"quantity": random.randint(1, 10),
"cost": float(fake.price())
} for _ in range(items_count)
]

total = sum(item['cost'] for item in items)

return {
"id": fake.uuid4(),
"date": fake.past_date(),
"name": fake.name(),
"items": items,
"total": total
}
12 changes: 12 additions & 0 deletions python/generate-pdf/src/main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
def main():
fake_order = generate_fake_order()
print(f"Generated fake order: {fake_order}")

pdf_buffer = create_pdf(fake_order)
print("PDF created.")

# If you want to write the PDF to a file:
# with open("output.pdf", "wb") as f:
# f.write(pdf_buffer)

return pdf_buffer
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This won't work, we need to use res.send() with the requisite headers. Please see examples of the template in other runtimes

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok got it!

19 changes: 19 additions & 0 deletions python/generate-pdf/src/pdf.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import pdfkit

def create_pdf(order):
content = """
<h2>Sample Invoice</h2>
<p>Date: {}</p>
<h3>Hello, {}!</h3>
<p>Order ID: {}</p>
<p>Total: ${:.2f}</p>
<ul>
""".format(order["date"], order["name"], order["id"], order["total"])

for item in order["items"]:
content += "<li>{} x {} = ${:.2f}</li>".format(item["description"], item["quantity"], item["cost"])

content += "</ul>"

pdf_bytes = pdfkit.from_string(content, False)
return pdf_bytes