Django example

[timkofu]

Hi,

I added a Django example to README.md

Summary by Sourcery

Documentation:

• Include a Django view sample demonstrating GET and POST handlers for WhatsApp webhook challenge and update callbacks in README

[sourcery-ai[bot]]

Reviewer's Guide

Introduces a new Django integration example in the README to demonstrate setting up a webhook endpoint with CSRF exemption and method handling using the WHATSAPP service.

Sequence diagram for Django WhatsApp webhook endpoint handling

sequenceDiagram
actor User
participant DjangoView as "Django whatsapp_endpoint view"
participant WhatsAppService as "WHATSAPP service"
User->>DjangoView: HTTP GET /whatsapp_endpoint
DjangoView->>WhatsAppService: webhook_challenge_handler(verify_token, challenge)
WhatsAppService-->>DjangoView: (response_content, status_code)
DjangoView-->>User: HttpResponse(response_content, status_code)

User->>DjangoView: HTTP POST /whatsapp_endpoint
DjangoView->>WhatsAppService: webhook_update_handler(update, hmac_header)
WhatsAppService-->>DjangoView: (response_content, status_code)
DjangoView-->>User: HttpResponse(response_content, status_code)

File-Level Changes

Change	Details	Files
Add Django webhook example section to README	Insert “Django example” heading Include required Django imports and service instantiation comments Apply csrf_exempt and require_http_methods decorators Implement GET handler for webhook challenge Implement POST handler for webhook updates	README.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an issue from a review comment by replying to it. You can also reply to a review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull request title to generate a title at any time. You can also comment @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in the pull request body to generate a PR summary at any time exactly where you want it. You can also comment @sourcery-ai summary on the pull request to (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the pull request to resolve all Sourcery comments. Useful if you've already addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull request to dismiss all existing Sourcery reviews. Especially useful if you want to start fresh with a new review - don't forget to comment @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[david-lev]

Hi @timkofu — thanks so much for this excellent contribution! 🙏 The Django example is really helpful and well done. I’m planning to expand our docs to include dedicated “Guides” sections for popular frameworks like Django, Flask, aiohttp, etc. I intend to create a separate Guides page in the docs (not within the README), and reference it from the README to keep things tidy. Your example would be the first entry on that page. Would you be comfortable if I move it over there in a future PR? Thanks again for your contribution — it’s greatly appreciated!

[timkofu]

Hi @david-lev

I intend to create a separate Guides page in the docs (not within the README), and reference it from the README to keep things tidy. Your example would be the first entry on that page. Would you be comfortable if I move it over there in a future PR?

Yes of course. That is perfect.

This is a great software, thanks for making it.