sendgrid-async 2.0.2__tar.gz → 2.0.3__tar.gz

sendgrid_async-2.0.3/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.1
+Name: sendgrid-async
+Version: 2.0.3
+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.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: certifi (>=2024.6.2,<2025.0.0)
+Requires-Dist: httpx (>=0.24.1,<0.25.0)
+Requires-Dist: sendgrid (>=6.7.0,<7.0.0)
+Requires-Dist: toml (>=0.10.2,<0.11.0)
+Project-URL: Repository, https://github.com/EM51641/async-sendgrid/
+Description-Content-Type: text/markdown
+
+# Async-Sendgrid
+
+[![Python](https://img.shields.io/pypi/pyversions/sendgrid-async)](https://pypi.org/project/sendgrid-async/)
+[![PyPI Latest Release](https://img.shields.io/pypi/v/sendgrid-async.svg)](https://pypi.org/project/sendgrid-async/)
+[![PyPI Downloads](https://img.shields.io/pypi/dm/sendgrid-async.svg?label=PyPI%20downloads)](https://pypi.org/project/sendgrid-async/)
+[![License - MIT](https://img.shields.io/pypi/l/async_sendgrid.svg)](https://github.com/sensodevices/async_sendgrid/blob/main/LICENSE)
+
+A modern, asynchronous SendGrid client built on top of `httpx`. This library provides a simple and efficient way to send emails using SendGrid's API with Python's async/await syntax.
+
+## Features
+
+- 🚀 Asynchronous email sending using `httpx`
+- 🔒 Type-safe with comprehensive type hints
+- ⚡️ Efficient connection pooling and session management
+- 🛠️ Compatible with SendGrid's official Python library
+- 📦 Easy installation and simple API
+
+## Requirements
+
+- Python 3.10 or higher
+- SendGrid API key
+
+## Installation
+
+Install the package using pip:
+
+```bash
+pip install sendgrid-async
+```
+
+Or using Poetry:
+
+```bash
+poetry add sendgrid-async
+```
+
+## Quick Start
+
+Here's a simple example of how to send an email:
+
+```python
+import os
+from async_sendgrid import SendgridAPI
+from sendgrid.helpers.mail import Content, Email, Mail, To
+
+# Initialize the client
+api_key = os.environ.get('SENDGRID_API_KEY')
+sendgrid = SendgridAPI(api_key)
+
+# Create email content
+from_email = Email("sender@example.com")
+to_email = To("recipient@example.com")
+subject = "Hello from Async-Sendgrid!"
+content = Content("text/plain", "This is a test email sent using Async-Sendgrid.")
+
+# Create mail object
+mail = Mail(from_email, to_email, subject, content)
+
+# Send the email
+async with sendgrid as client:
+    response = await client.send(mail)
+```
+
+## Advanced Usage
+
+### Custom Endpoint
+
+For testing or development purposes, you can specify a custom endpoint:
+
+```python
+sendgrid = SendgridAPI(
+    api_key="YOUR_API_KEY",
+    endpoint="https://localhost:3000/v3/mail/send"
+)
+```
+
+### Error Handling
+
+The library provides proper error handling for API responses:
+
+```python
+from async_sendgrid.exceptions import SendgridError
+
+try:
+    async with sendgrid as client:
+        response = await client.send(mail)
+except SendgridError as e:
+    print(f"Failed to send email: {e}")
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

sendgrid_async-2.0.3/README.md

@@ -0,0 +1,103 @@
+# Async-Sendgrid
+
+[![Python](https://img.shields.io/pypi/pyversions/sendgrid-async)](https://pypi.org/project/sendgrid-async/)
+[![PyPI Latest Release](https://img.shields.io/pypi/v/sendgrid-async.svg)](https://pypi.org/project/sendgrid-async/)
+[![PyPI Downloads](https://img.shields.io/pypi/dm/sendgrid-async.svg?label=PyPI%20downloads)](https://pypi.org/project/sendgrid-async/)
+[![License - MIT](https://img.shields.io/pypi/l/async_sendgrid.svg)](https://github.com/sensodevices/async_sendgrid/blob/main/LICENSE)
+
+A modern, asynchronous SendGrid client built on top of `httpx`. This library provides a simple and efficient way to send emails using SendGrid's API with Python's async/await syntax.
+
+## Features
+
+- 🚀 Asynchronous email sending using `httpx`
+- 🔒 Type-safe with comprehensive type hints
+- ⚡️ Efficient connection pooling and session management
+- 🛠️ Compatible with SendGrid's official Python library
+- 📦 Easy installation and simple API
+
+## Requirements
+
+- Python 3.10 or higher
+- SendGrid API key
+
+## Installation
+
+Install the package using pip:
+
+```bash
+pip install sendgrid-async
+```
+
+Or using Poetry:
+
+```bash
+poetry add sendgrid-async
+```
+
+## Quick Start
+
+Here's a simple example of how to send an email:
+
+```python
+import os
+from async_sendgrid import SendgridAPI
+from sendgrid.helpers.mail import Content, Email, Mail, To
+
+# Initialize the client
+api_key = os.environ.get('SENDGRID_API_KEY')
+sendgrid = SendgridAPI(api_key)
+
+# Create email content
+from_email = Email("sender@example.com")
+to_email = To("recipient@example.com")
+subject = "Hello from Async-Sendgrid!"
+content = Content("text/plain", "This is a test email sent using Async-Sendgrid.")
+
+# Create mail object
+mail = Mail(from_email, to_email, subject, content)
+
+# Send the email
+async with sendgrid as client:
+    response = await client.send(mail)
+```
+
+## Advanced Usage
+
+### Custom Endpoint
+
+For testing or development purposes, you can specify a custom endpoint:
+
+```python
+sendgrid = SendgridAPI(
+    api_key="YOUR_API_KEY",
+    endpoint="https://localhost:3000/v3/mail/send"
+)
+```
+
+### Error Handling
+
+The library provides proper error handling for API responses:
+
+```python
+from async_sendgrid.exceptions import SendgridError
+
+try:
+    async with sendgrid as client:
+        response = await client.send(mail)
+except SendgridError as e:
+    print(f"Failed to send email: {e}")
+```
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

sendgrid_async-2.0.3/async_sendgrid/exception.py

@@ -0,0 +1,8 @@
+class SessionClosedException(Exception):
+    """
+    Exception raised when the session is closed unexpectedly.
+    """
+
+    def __init__(self, message: str):
+        self.message = message
+        super().__init__(self.message)

{sendgrid_async-2.0.2 → sendgrid_async-2.0.3}/async_sendgrid/sendgrid.py

@@ -5,6 +5,7 @@ from typing import TYPE_CHECKING
 
 from httpx import AsyncClient  # type: ignore
 
+from async_sendgrid.exception import SessionClosedException
 from async_sendgrid.utils import create_session
 
 if TYPE_CHECKING:
@@ -30,10 +31,23 @@ class BaseSendgridAPI(ABC):
     def headers(self) -> dict[Any, Any]:
         """Not implemented"""
 
+    @property
+    @abstractmethod
+    def session(self) -> AsyncClient | None:
+        """Not implemented"""
+
     @abstractmethod
     async def send(self, message: Mail) -> Response:
         """Not implemented"""
 
+    @abstractmethod
+    async def __aenter__(self) -> BaseSendgridAPI:
+        """Not implemented"""
+
+    @abstractmethod
+    async def __aexit__(self, exc_type: Any, exc: Any, tb: Any) -> None:
+        """Not implemented"""
+
 
 class SendgridAPI(BaseSendgridAPI):
     """
@@ -84,6 +98,10 @@ class SendgridAPI(BaseSendgridAPI):
     def headers(self) -> dict[Any, Any]:
         return self._headers
 
+    @property
+    def session(self) -> AsyncClient | None:
+        return self._session
+
     async def send(self, message: Mail) -> Response:
         """
         Make a Twilio SendGrid v3 API request with the request body generated
@@ -99,18 +117,27 @@ class SendgridAPI(BaseSendgridAPI):
         """
         assert self._session
 
+        if self._session.is_closed:
+            raise SessionClosedException(
+                "Session was closed, establishing new connection"
+            )
+
         json_message = message.get()
         response = await self._session.post(
             url=self._endpoint, json=json_message
         )
         return response
 
-    async def __aenter__(self):
-        if not self._session or self._session.is_closed:
-            self._session = create_session(headers=self._headers)
+    async def __aenter__(self) -> SendgridAPI:
+        self._session = create_session(headers=self._headers)
         return self
 
-    async def __aexit__(self, exc_type: Any, exc: Any, tb: Any):
+    async def __aexit__(self, exc_type: Any, exc: Any, tb: Any) -> None:
         assert self._session
-
         await self._session.aclose()
+
+    def __str__(self) -> str:
+        return f"SendGrid API Client\n  • Endpoint: {self._endpoint}\n"
+
+    def __repr__(self) -> str:
+        return f"SendgridAPI(endpoint={self._endpoint})"

{sendgrid_async-2.0.2 → sendgrid_async-2.0.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "sendgrid-async"
-version = "2.0.2"
+version = "2.0.3"
 description = "SendGrid using a client based on httpx."
 license = "MIT"
 authors = ["Elyes Mahjoubo <elyesmahjoubi@gmail.com>"]
@@ -13,12 +13,18 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
 ]
 
 packages = [
     { include = "async_sendgrid" },
 ]
 
+include = [
+    "LICENSE",
+    "README.md"
+]
+
 [tool.poetry.dependencies]
 python = "^3.10"
 sendgrid = "^6.7.0"

sendgrid_async-2.0.2/PKG-INFO

@@ -1,85 +0,0 @@
-Metadata-Version: 2.1
-Name: sendgrid-async
-Version: 2.0.2
-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: certifi (>=2024.6.2,<2025.0.0)
-Requires-Dist: httpx (>=0.24.1,<0.25.0)
-Requires-Dist: sendgrid (>=6.7.0,<7.0.0)
-Requires-Dist: toml (>=0.10.2,<0.11.0)
-Project-URL: Repository, https://github.com/EM51641/async-sendgrid/
-Description-Content-Type: text/markdown
-
-| | |
-| --- | --- |
-| Python| ![Python](https://img.shields.io/pypi/pyversions/sendgrid-async) |
-| Package | [![PyPI Latest Release](https://img.shields.io/pypi/v/sendgrid-async.svg)](https://pypi.org/project/sendgrid-async/) [![PyPI Downloads](https://img.shields.io/pypi/dm/sendgrid-async.svg?label=PyPI%20downloads)](https://pypi.org/project/sendgrid-async/) |
-| Meta | [![License - MIT](https://img.shields.io/pypi/l/async_sendgrid.svg)](https://github.com/sensodevices/async_sendgrid/blob/main/LICENSE)|
-
-# Async-Sendgrid
-
-Sendgrid-Async is a simple asynchronous client built upon the httpx library.
-
-# Installation
-
-You can install Sendgrid-Async using pip with the following command:
-
-```shell
-pip install sendgrid-async
-```
-
-# Usage
-
-Here is a brief script demonstrating how to send an email using Async-Sendgrid:
-
-First, import the `SendgridAPI` from the `sendgrid-async` package. Then, create a SendgridAPI object using your API key.
-
-```python
-from async_sendgrid import SendgridAPI
-import os
-
-API_KEY = os.environ.get('SECRET_API_KEY')
-sendgrid = SendgridAPI(API_KEY)
-```
-
-Next, we can create an email using the original `sendgrid` library as follows:
-
-```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
-    )
-```
-
-An email can be sent to sendgrid servers with the  `send` API of the `SendgridAPI` instance:
-
-```python
-async with sendgrid as client:
-    response = await client.send(data)
-```
-
-For testing purposes, you can modify the API endpoint as follows:
-
-```python
-sendgrid = SendgridAPI(api_key="SECRET_API_KEY", endpoint="https://localhost:3000/v3/mail/send")
-```

sendgrid_async-2.0.2/README.md

@@ -1,62 +0,0 @@
-| | |
-| --- | --- |
-| Python| ![Python](https://img.shields.io/pypi/pyversions/sendgrid-async) |
-| Package | [![PyPI Latest Release](https://img.shields.io/pypi/v/sendgrid-async.svg)](https://pypi.org/project/sendgrid-async/) [![PyPI Downloads](https://img.shields.io/pypi/dm/sendgrid-async.svg?label=PyPI%20downloads)](https://pypi.org/project/sendgrid-async/) |
-| Meta | [![License - MIT](https://img.shields.io/pypi/l/async_sendgrid.svg)](https://github.com/sensodevices/async_sendgrid/blob/main/LICENSE)|
-
-# Async-Sendgrid
-
-Sendgrid-Async is a simple asynchronous client built upon the httpx library.
-
-# Installation
-
-You can install Sendgrid-Async using pip with the following command:
-
-```shell
-pip install sendgrid-async
-```
-
-# Usage
-
-Here is a brief script demonstrating how to send an email using Async-Sendgrid:
-
-First, import the `SendgridAPI` from the `sendgrid-async` package. Then, create a SendgridAPI object using your API key.
-
-```python
-from async_sendgrid import SendgridAPI
-import os
-
-API_KEY = os.environ.get('SECRET_API_KEY')
-sendgrid = SendgridAPI(API_KEY)
-```
-
-Next, we can create an email using the original `sendgrid` library as follows:
-
-```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
-    )
-```
-
-An email can be sent to sendgrid servers with the  `send` API of the `SendgridAPI` instance:
-
-```python
-async with sendgrid as client:
-    response = await client.send(data)
-```
-
-For testing purposes, you can modify the API endpoint as follows:
-
-```python
-sendgrid = SendgridAPI(api_key="SECRET_API_KEY", endpoint="https://localhost:3000/v3/mail/send")
-```