sendgrid-async 1.0.0__tar.gz

sendgrid_async-1.0.0/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2023, Elyes Mahjoubi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

sendgrid_async-1.0.0/PKG-INFO

@@ -0,0 +1,78 @@
+Metadata-Version: 2.1
+Name: sendgrid-async
+Version: 1.0.0
+Summary: SendGrid using a client based on httpx.
+Home-page: https://github.com/EM51641/async-sendgrid/
+License: MIT
+Keywords: sendgrid,async,httpx
+Author: Elyes Mahjoubo
+Author-email: elyesmahjoubi@gmail.com
+Requires-Python: >=3.10,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: httpx (>=0.24.1,<0.25.0)
+Requires-Dist: sendgrid (>=6.7.0,<7.0.0)
+Project-URL: Repository, https://github.com/EM51641/async-sendgrid/
+Description-Content-Type: text/markdown
+
+| | |
+| --- | --- |
+| Python| ![Python](https://img.shields.io/pypi/pyversions/async-sendgrid) |
+| Package | [![PyPI Latest Release](https://img.shields.io/pypi/v/pandas.svg)](https://pypi.org/project/async-sendgrid/) [![PyPI Downloads](https://img.shields.io/pypi/dm/async-sendgrid.svg?label=PyPI%20downloads)](https://pypi.org/project/async-sendgrid/) |
+| Meta | [![License - MIT](https://img.shields.io/pypi/l/async_sendgrid.svg)](https://github.com/sensodevices/async_sendgrid/blob/main/LICENSE)|
+
+# Async-Sendgrid
+
+Sendgrid simple asynchronous client based on the httpx libarary.
+
+# Installation
+
+It is possible to install async-sendgrid with pip:
+
+```bash
+pip install async-sendgrid
+```
+
+# Usage
+This is a small script showing how to send an email with async-sendgrid:
+
+First, you need to import the ```SendgridAPI``` from the ```async_sendgrid``` package. Then, you need to create a ```SendgridAPI``` object with your API key.
+
+```python
+from async_sendgrid import SendgridAPI
+import os
+
+API_KEY = os.environ.get['API_KEY']
+sendgrid = SendgridAPI(API_KEY)
+```
+
+Thereafter, you can create an email with the original ```sendgrid``` package such:
+
+```python
+from sendgrid.helpers.mail import Content, Email, Mail, To
+
+from_email = Email("test@example.com")
+to_email = To("test@example.com")
+subject = "Lorem ipsum dolor sit amet, consectetur adipiscing elit"
+content = Content("text/plain", "Sed varius ligula ac urna vehicula ultrices. Nunc ut dolor sem.")
+
+mail = Mail(
+    from_email=from_email,
+    to_email=to_email,
+    subject=subject,
+    content=content
+    )
+
+```
+
+Finally you can send the email with the ```send``` method of the ```SendgridAPI``` instance:
+
+```python
+async with sendgrid as client:
+    response = await client.send(data)
+```
+

sendgrid_async-1.0.0/README.md

@@ -0,0 +1,56 @@
+| | |
+| --- | --- |
+| Python| ![Python](https://img.shields.io/pypi/pyversions/async-sendgrid) |
+| Package | [![PyPI Latest Release](https://img.shields.io/pypi/v/pandas.svg)](https://pypi.org/project/async-sendgrid/) [![PyPI Downloads](https://img.shields.io/pypi/dm/async-sendgrid.svg?label=PyPI%20downloads)](https://pypi.org/project/async-sendgrid/) |
+| Meta | [![License - MIT](https://img.shields.io/pypi/l/async_sendgrid.svg)](https://github.com/sensodevices/async_sendgrid/blob/main/LICENSE)|
+
+# Async-Sendgrid
+
+Sendgrid simple asynchronous client based on the httpx libarary.
+
+# Installation
+
+It is possible to install async-sendgrid with pip:
+
+```bash
+pip install async-sendgrid
+```
+
+# Usage
+This is a small script showing how to send an email with async-sendgrid:
+
+First, you need to import the ```SendgridAPI``` from the ```async_sendgrid``` package. Then, you need to create a ```SendgridAPI``` object with your API key.
+
+```python
+from async_sendgrid import SendgridAPI
+import os
+
+API_KEY = os.environ.get['API_KEY']
+sendgrid = SendgridAPI(API_KEY)
+```
+
+Thereafter, you can create an email with the original ```sendgrid``` package such:
+
+```python
+from sendgrid.helpers.mail import Content, Email, Mail, To
+
+from_email = Email("test@example.com")
+to_email = To("test@example.com")
+subject = "Lorem ipsum dolor sit amet, consectetur adipiscing elit"
+content = Content("text/plain", "Sed varius ligula ac urna vehicula ultrices. Nunc ut dolor sem.")
+
+mail = Mail(
+    from_email=from_email,
+    to_email=to_email,
+    subject=subject,
+    content=content
+    )
+
+```
+
+Finally you can send the email with the ```send``` method of the ```SendgridAPI``` instance:
+
+```python
+async with sendgrid as client:
+    response = await client.send(data)
+```

sendgrid_async-1.0.0/async_sendgrid/__init__.py

@@ -0,0 +1,3 @@
+from .sendgrid import SendgridAPI  # noqa
+
+__version__ = "0.0.2"

sendgrid_async-1.0.0/async_sendgrid/sendgrid.py

@@ -0,0 +1,118 @@
+from __future__ import annotations
+
+from abc import ABC, abstractmethod
+from typing import TYPE_CHECKING
+
+import async_sendgrid
+from async_sendgrid.utils import create_session
+
+if TYPE_CHECKING:
+    from typing import Any, Optional
+
+    from httpx import Response  # type: ignore
+    from sendgrid.helpers.mail import Mail  # type: ignore
+
+
+class BaseSendgridAPI(ABC):
+    @property
+    @abstractmethod
+    def api_key(self) -> str:
+        """Not implemented"""
+
+    @property
+    @abstractmethod
+    def endpoint(self) -> str:
+        """Not implemented"""
+
+    @property
+    @abstractmethod
+    def version(self) -> str:
+        """Not implemented"""
+
+    @property
+    @abstractmethod
+    def headers(self) -> dict[Any, Any]:
+        """Not implemented"""
+
+    @abstractmethod
+    async def send(self, message: dict[Any, Any] | Mail) -> Response:
+        """Not implemented"""
+
+
+class SendgridAPI(BaseSendgridAPI):
+    """
+    Construct the Twilio SendGrid v3 API object.
+    Note that the underlying client is being Setup during initialization,
+    therefore changing attributes in runtime will not affect HTTP client
+    behaviour.
+
+    :param api_key: The api key issued by Sendgrid.
+    :param impersonate_subuser: the subuser to impersonate. Will be passed
+        by "On-Behalf-Of" header by underlying client.
+        See https://sendgrid.com/docs/User_Guide/Settings/subusers.html
+        for more details.
+    """
+
+    def __init__(
+        self,
+        api_key: str,
+        impersonate_subuser: Optional[str] = None,
+    ):
+        self._api_key = api_key
+        self._endpoint = "https://api.sendgrid.com/v3/mail/send"
+        self._version = async_sendgrid.__version__
+
+        self._headers = {
+            "Authorization": f"Bearer {self._api_key}",
+            "User-Agent": f"async_sendgrid/{self._version};python",
+            "Accept": "*/*",
+            "Content-Type": "application/json",
+        }
+
+        if impersonate_subuser:
+            self._headers["On-Behalf-Of"] = impersonate_subuser
+
+        self._session = create_session(self._headers)
+
+    @property
+    def api_key(self) -> str:
+        return self._api_key
+
+    @property
+    def endpoint(self) -> str:
+        return self._endpoint
+
+    @property
+    def version(self) -> str:
+        return self._version
+
+    @property
+    def headers(self) -> dict[Any, Any]:
+        return self._headers
+
+    async def send(self, message: Mail) -> Response:
+        """
+        Make a Twilio SendGrid v3 API request with the request body generated
+        by the Mail object
+
+        Parameters:
+        ----
+            :param message: The Twilio SendGrid v3 API request body generated
+                by the Mail object or dict
+        Returns:
+        ----
+            :return: The Twilio SendGrid v3 API response
+        """
+        json_message = message.get()
+        response = await self._session.post(
+            url=self._endpoint, json=json_message
+        )
+        return response
+
+    async def __aenter__(self):
+        if self._session.is_closed:
+            self._session = create_session(headers=self._headers)
+        return self
+
+    async def __aexit__(self, exc_type: Any, exc: Any, tb: Any):
+        await self._session.aclose()

sendgrid_async-1.0.0/async_sendgrid/utils.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from httpx import AsyncClient  # type: ignore
+
+if TYPE_CHECKING:
+    from typing import Any
+
+
+def create_session(headers: dict[Any, Any]) -> AsyncClient:
+    """
+    create an httpx session.
+
+    Parameters
+    ----------
+        headers : dict[Any, Any]
+
+    Returns
+    -------
+        AsyncClient
+    """
+    session = AsyncClient(headers=headers)
+    return session

sendgrid_async-1.0.0/pyproject.toml

@@ -0,0 +1,47 @@
+[tool.poetry]
+name = "sendgrid-async"
+version = "1.0.0"
+description = "SendGrid using a client based on httpx."
+license = "MIT"
+authors = ["Elyes Mahjoubo <elyesmahjoubi@gmail.com>"]
+readme = "README.md"
+repository = "https://github.com/EM51641/async-sendgrid/"
+keywords = ["sendgrid", "async", "httpx"]
+classifiers = [
+    "Operating System :: OS Independent",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+
+packages = [
+    { include = "async_sendgrid" },
+]
+
+[tool.poetry.dependencies]
+python = "^3.10"
+sendgrid = "^6.7.0"
+httpx = "^0.24.1"
+
+[tool.poetry.dev-dependencies]
+pytest = "^7.4.2"
+pytest-asyncio = "^0.15.1"
+pytest-cov = "^4.0.0"
+pytest-httpx="^0.24.0"
+mypy = "^1.0.0"
+flake8 = "^6.0.0"
+black = "^23.9.0"
+tox = "^4.11.1"
+
+[tool.black]
+line-length = 79
+
+[tool.coverage.report]
+exclude_also = [
+    "if TYPE_CHECKING:",
+    ]
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"