From 0e03b8546696d96872c361f2add510111f182f98 Mon Sep 17 00:00:00 2001 From: Giorgi Merebashvili Date: Sat, 21 Feb 2026 18:36:10 +0400 Subject: [PATCH 1/2] docs: Make examples better --- README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index bba639d..989cba8 100644 --- a/README.md +++ b/README.md @@ -51,10 +51,15 @@ from fluxqueue import FluxQueue fluxqueue = FluxQueue() @fluxqueue.task() -def send_email(to: str, subject: str, body: str): - print(f"Sending email to {to}") - print(f"Subject: {subject}") - print(f"Body: {body}") +def send_email(to_email: str, subject: str, body: str): + with email_context() as email_client: + message = EmailMessage() + message["From"] = "test@example.com" + message["To"] = to_email + message["Subject"] = subject + message.set_content(body) + + email_client.send_message(message) ``` ### Enqueue Tasks @@ -73,8 +78,15 @@ FluxQueue supports async functions too. Just define an async function and use th ```python @fluxqueue.task() -async def process_data(data: dict): - await some_async_operation(data) +async def send_email(data: dict): + async with email_context() as email_client: + message = EmailMessage() + message["From"] = "test@example.com" + message["To"] = to_email + message["Subject"] = subject + message.set_content(body) + + await email_client.send_message(message) ``` Running the async function in an async context will also enqueue the task. From 93b5e24656913744557729ab422d13c96bb97011 Mon Sep 17 00:00:00 2001 From: Giorgi Merebashvili Date: Sat, 21 Feb 2026 18:43:22 +0400 Subject: [PATCH 2/2] Update docs --- README.md | 4 ++-- docs/tutorial/quickstart.md | 31 ++++++++++++++++++++----------- 2 files changed, 22 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 989cba8..22838d5 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ def send_email(to_email: str, subject: str, body: str): message["To"] = to_email message["Subject"] = subject message.set_content(body) - + email_client.send_message(message) ``` @@ -85,7 +85,7 @@ async def send_email(data: dict): message["To"] = to_email message["Subject"] = subject message.set_content(body) - + await email_client.send_message(message) ``` diff --git a/docs/tutorial/quickstart.md b/docs/tutorial/quickstart.md index 94b6510..af95fbd 100644 --- a/docs/tutorial/quickstart.md +++ b/docs/tutorial/quickstart.md @@ -14,11 +14,15 @@ fluxqueue = FluxQueue() # Define a task using the @fluxqueue.task decorator @fluxqueue.task() -def send_email(to: str, subject: str, body: str): - print(f"Sending email to {to}") - print(f"Subject: {subject}") - print(f"Body: {body}") - # Your email sending logic here +def send_email(to_email: str, subject: str, body: str): + with email_context() as email_client: + message = EmailMessage() + message["From"] = "test@example.com" + message["To"] = to_email + message["Subject"] = subject + message.set_content(body) + + email_client.send_message(message) ``` ## Enqueue Tasks @@ -38,13 +42,18 @@ FluxQueue supports async functions too. Just define an async function and use th ```python @fluxqueue.task() -async def process_data(data: dict): - # Your async processing logic - result = await some_async_operation(data) - return result +async def send_email(to_email: str, subject: str, body: str): + async with email_context() as email_client: + message = EmailMessage() + message["From"] = "test@example.com" + message["To"] = to_email + message["Subject"] = subject + message.set_content(body) -# Enqueue it (use await in async contexts) -await process_data({"key": "value"}) + await email_client.send_message(message) + +# Enqueue the task +asyncio.run(send_email("user@example.com", "Hello", "This is a test email")) ``` ## Task Options