{"author":"Elmer Thomas, Yamil Asusta","author_email":"help@twilio.com","bugtrack_url":null,"classifiers":["Programming Language :: Python :: 2.7","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Programming Language :: Python :: 3.5","Programming Language :: Python :: 3.6","Programming Language :: Python :: 3.7","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9"],"description":".. image:: https://github.com/sendgrid/sendgrid-python/raw/HEAD/twilio_sendgrid_logo.png\n :target: https://www.sendgrid.com\n\n\n\n|Tests Badge| |Python Versions| |PyPI Version| |Docker Badge| |MIT licensed| |Twitter Follow| |GitHub contributors| |Open Source Helpers|\n\n**This library allows you to quickly and easily use the Twilio SendGrid Web API v3 via Python.**\n\n**NEW:**\n\n- Version 6.X release is a BREAKING CHANGE from version 5.X, please see the `release notes`_ for details.\n- Send SMS messages with `Twilio`_.\n\nThis library provides full support for all Twilio SendGrid `Web API v3`_ endpoints, including `v3 /mail/send`_.\n\nWe want this library to be community driven and Twilio SendGrid led.\nWe need your help to realize this goal.\nTo help make sure we are building the right things in the right order,\nwe ask that you create `issues`_ and `pull requests`_ or simply upvote or comment on existing issues or pull requests.\n\nPlease browse the rest of this README for further detail.\n\nWe appreciate your continued support, thank you!\n\nTable of Contents\n=================\n\n- `Installation <#installation>`__\n- `Quick Start <#quick-start>`__\n- `Common Use Cases <#use-cases>`__\n- `General Usage <#usage>`__\n- `Processing Inbound Email <#processing-inbound-email>`__\n- `Announcements <#announcements>`__\n- `How to Contribute <#how-to-contribute>`__\n- `Troubleshooting <#troubleshooting>`__\n- `About <#about>`__\n- `License <#license>`__\n\nInstallation\n============\n\nPrerequisites\n-------------\n\n- Python version 2.7 and 3.5+\n- For email, you will need a Twilio SendGrid account, starting at the `free level`_\n- For SMS messages, you will need a free `Twilio account`_\n\nSetup Environment Variables\n---------------------------\n\nMac\n~~~\n\nUpdate the development environment with your `SENDGRID_API_KEY`_ (more info `here `__), for example:\n\n.. code:: bash\n\n echo \"export SENDGRID_API_KEY='YOUR_API_KEY'\" > sendgrid.env\n echo \"sendgrid.env\" >> .gitignore\n source ./sendgrid.env\n\nTwilio SendGrid also supports local environment file ``.env``.\nCopy or rename ``.env_sample`` into ``.env`` and update `SENDGRID_API_KEY`_ with your key.\n\nWindows\n~~~~~~~\n\nTemporarily set the environment variable (accessible only during the current CLI session):\n\n.. code:: bash\n\n set SENDGRID_API_KEY=YOUR_API_KEY\n\nPermanently set the environment variable (accessible in all subsequent CLI sessions):\n\n.. code:: bash\n\n setx SENDGRID_API_KEY \"YOUR_API_KEY\"\n\nInstall Package\n---------------\n\n.. code:: bash\n\n pip install sendgrid\n\nDependencies\n------------\n\n- `Python-HTTP-Client`_\n- `ECDSA-Python`_\n\nQuick Start\n===========\n\nHello Email\n-----------\n\nThe following is the minimum needed code to send an email with the `/mail/send Helper`_\n(`here `__ is a full example):\n\nWith Mail Helper Class\n~~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: python\n\n import os\n from sendgrid import SendGridAPIClient\n from sendgrid.helpers.mail import Mail\n\n message = Mail(\n from_email='from_email@example.com',\n to_emails='to@example.com',\n subject='Sending with Twilio SendGrid is Fun',\n html_content='and easy to do anywhere, even with Python')\n try:\n sg = SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))\n response = sg.send(message)\n print(response.status_code)\n print(response.body)\n print(response.headers)\n except Exception as e:\n print(str(e))\n\nThe ``Mail`` constructor creates a `personalization object`_ for you.\n`Here `__ is an example of how to add it.\n\nWithout Mail Helper Class\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThe following is the minimum needed code to send an email without the /mail/send Helper\n(`here `__ is a full example):\n\n.. code:: python\n\n import os\n from sendgrid import SendGridAPIClient\n\n message = {\n 'personalizations': [\n {\n 'to': [\n {\n 'email': 'test@example.com'\n }\n ],\n 'subject': 'Sending with Twilio SendGrid is Fun'\n }\n ],\n 'from': {\n 'email': 'test@example.com'\n },\n 'content': [\n {\n 'type': 'text/plain',\n 'value': 'and easy to do anywhere, even with Python'\n }\n ]\n }\n try:\n sg = SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))\n response = sg.send(message)\n print(response.status_code)\n print(response.body)\n print(response.headers)\n except Exception as e:\n print(str(e))\n\nGeneral v3 Web API Usage (With `Fluent Interface`_)\n---------------------------------------------------\n\n.. code:: python\n\n import os\n from sendgrid import SendGridAPIClient\n\n sg = SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))\n response = sg.client.suppression.bounces.get()\n print(response.status_code)\n print(response.body)\n print(response.headers)\n\nGeneral v3 Web API Usage (Without `Fluent Interface`_)\n------------------------------------------------------\n\n.. code:: python\n\n import os\n from sendgrid import SendGridAPIClient\n\n sg = SendGridAPIClient(os.environ.get('SENDGRID_API_KEY'))\n response = sg.client._('suppression/bounces').get()\n print(response.status_code)\n print(response.body)\n print(response.headers)\n\nProcessing Inbound Email\n========================\n\nPlease see `our helper`_ for utilizing our Inbound Parse webhook.\n\nUsage\n=====\n\n- `Twilio SendGrid Documentation`_\n- `Library Usage Documentation`_\n- `Example Code`_\n- `How-to: Migration from v2 to v3`_\n- `v3 Web API Mail Send Helper`_ - build a request object payload for a v3 /mail/send API call.\n- `Processing Inbound Email`_\n\nUse Cases\n=========\n\n`Examples of common API use cases`_, such as how to send an email with a transactional template or add an attachment or send an SMS message.\n\nAnnouncements\n=============\n\nAll updates to this library are documented in our `CHANGELOG`_ and `releases`_.\n\nHow to Contribute\n=================\n\nWe encourage contribution to our libraries (you might even score some nifty swag), please see our `CONTRIBUTING`_ guide for details.\n\nQuick links:\n\n- `Feature Request`_\n- `Bug Reports`_\n- `Improvements to the Codebase`_\n- `Review Pull Requests`_\n\nTroubleshooting\n===============\n\nPlease see our `troubleshooting guide`_ for common library issues.\n\nAbout\n=====\n\n**sendgrid-python** is maintained and funded by Twilio SendGrid, Inc.\nThe names and logos for **sendgrid-python** are trademarks of Twilio SendGrid, Inc.\n\nLicense\n=======\n\n`The MIT License (MIT)`_\n\n.. _Twilio: https://github.com/sendgrid/sendgrid-python/blob/HEAD/use_cases/sms.md\n.. _release notes: https://github.com/sendgrid/sendgrid-python/releases/tag/v6.0.0\n.. _Web API v3: https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html\n.. _v3 /mail/send: https://sendgrid.com/blog/introducing-v3mailsend-sendgrids-new-mail-endpoint\n.. _issues: https://github.com/sendgrid/sendgrid-python/issues\n.. _pull requests: https://github.com/sendgrid/sendgrid-python/blob/HEAD/CONTRIBUTING.md\n.. _free level: https://sendgrid.com/free?source=sendgrid-python\n.. _Twilio account: https://www.twilio.com/try-twilio?source=sendgrid-python\n.. _SENDGRID_API_KEY: https://app.sendgrid.com/settings/api_keys\n.. _Python-HTTP-Client: https://github.com/sendgrid/python-http-client\n.. _ECDSA-Python: https://github.com/starkbank/ecdsa-python\n.. _/mail/send Helper: https://github.com/sendgrid/sendgrid-python/tree/HEAD/sendgrid/helpers/mail\n.. _personalization object: https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/personalizations.html\n.. _Fluent Interface: https://sendgrid.com/blog/using-python-to-implement-a-fluent-interface-to-any-rest-api/\n.. _our helper: https://github.com/sendgrid/sendgrid-python/tree/HEAD/sendgrid/helpers/inbound\n.. _Twilio SendGrid Documentation: https://sendgrid.com/docs/API_Reference/index.html\n.. _Library Usage Documentation: https://github.com/sendgrid/sendgrid-python/tree/HEAD/USAGE.md\n.. _Example Code: https://github.com/sendgrid/sendgrid-python/tree/HEAD/examples\n.. _`How-to: Migration from v2 to v3`: https://sendgrid.com/docs/Classroom/Send/v3_Mail_Send/how_to_migrate_from_v2_to_v3_mail_send.html\n.. _v3 Web API Mail Send Helper: https://github.com/sendgrid/sendgrid-python/tree/HEAD/sendgrid/helpers/mail\n.. _Processing Inbound Email: https://github.com/sendgrid/sendgrid-python/tree/HEAD/sendgrid/helpers/inbound\n.. _Examples of common API use cases: https://github.com/sendgrid/sendgrid-python/blob/HEAD/use_cases/README.md\n.. _breaking changes: https://github.com/sendgrid/sendgrid-python/issues/217\n.. _CHANGELOG: https://github.com/sendgrid/sendgrid-python/blob/HEAD/CHANGELOG.md\n.. _releases: https://github.com/sendgrid/sendgrid-python/releases\n.. _CONTRIBUTING: https://github.com/sendgrid/sendgrid-python/blob/HEAD/CONTRIBUTING.md\n.. _Feature Request: https://github.com/sendgrid/sendgrid-python/blob/HEAD/CONTRIBUTING.md#feature-request\n.. _Bug Reports: https://github.com/sendgrid/sendgrid-python/blob/HEAD/CONTRIBUTING.md#submit-a-bug-report\n.. _Improvements to the Codebase: https://github.com/sendgrid/sendgrid-python/blob/HEAD/CONTRIBUTING.md#improvements-to-the-codebase\n.. _Review Pull Requests: https://github.com/sendgrid/sendgrid-python/blob/HEAD/CONTRIBUTING.md#code-reviews\n.. _troubleshooting guide: https://github.com/sendgrid/sendgrid-python/blob/HEAD/TROUBLESHOOTING.md\n.. _The MIT License (MIT): https://github.com/sendgrid/sendgrid-python/blob/HEAD/LICENSE\n\n.. |Tests Badge| image:: https://github.com/sendgrid/sendgrid-python/actions/workflows/test.yml/badge.svg\n :target: https://github.com/sendgrid/sendgrid-python/actions/workflows/test.yml\n.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/sendgrid.svg\n :target: https://pypi.org/project/sendgrid/\n.. |PyPI Version| image:: https://img.shields.io/pypi/v/sendgrid.svg\n :target: https://pypi.org/project/sendgrid/\n.. |Docker Badge| image:: https://img.shields.io/docker/automated/sendgrid/sendgrid-python.svg\n :target: https://hub.docker.com/r/sendgrid/sendgrid-python/\n.. |MIT licensed| image:: https://img.shields.io/badge/license-MIT-blue.svg\n :target: ./LICENSE\n.. |Twitter Follow| image:: https://img.shields.io/twitter/follow/sendgrid.svg?style=social&label=Follow\n :target: https://twitter.com/sendgrid\n.. |GitHub contributors| image:: https://img.shields.io/github/contributors/sendgrid/sendgrid-python.svg\n :target: https://github.com/sendgrid/sendgrid-python/graphs/contributors\n.. |Open Source Helpers| image:: https://www.codetriage.com/sendgrid/sendgrid-python/badges/users.svg\n :target: https://www.codetriage.com/sendgrid/sendgrid-python\n","description_content_type":null,"docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":"https://github.com/sendgrid/sendgrid-python/","keywords":null,"license":"MIT","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"sendgrid","package_url":"https://pypi.org/project/sendgrid/","platform":null,"project_url":"https://pypi.org/project/sendgrid/","project_urls":{"Homepage":"https://github.com/sendgrid/sendgrid-python/"},"provides_extra":null,"release_url":"https://pypi.org/project/sendgrid/6.12.2/","requires_dist":["python-http-client>=3.2.1","ecdsa<1,>=0.19.1","werkzeug<1.0.0,>=0.11.15; python_version < \"3.0\"","werkzeug<2.0.0,>=0.15.0; python_version >= \"3.0\" and python_version < \"3.6\"","werkzeug>=3.0.0; python_version >= \"3.11\"","werkzeug<3.0.0,>=2.0.0; python_version >= \"3.6\" and python_version < \"3.11\""],"requires_python":"!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,>=2.7","summary":"Twilio SendGrid library for Python","version":"6.12.2","yanked":false,"yanked_reason":null}

Dependencies of sendgrid (3).
Dependency	Optional
ecdsa	false
python-http-client	false
werkzeug	false

Package search

sendgrid

project_urls

Dependencies

All package metadata

Releases