swarmauri_tool_gmail 0.6.0.dev154__tar.gz

swarmauri_tool_gmail-0.6.0.dev154/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.3
+Name: swarmauri_tool_gmail
+Version: 0.6.0.dev154
+Summary: example community package
+License: Apache-2.0
+Author: Jacob Stewart
+Author-email: jacob@swarmauri.com
+Requires-Python: >=3.10,<3.13
+Classifier: License :: OSI Approved :: Apache Software License
+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: swarmauri_base (>=0.6.0.dev154,<0.7.0)
+Requires-Dist: swarmauri_core (>=0.6.0.dev154,<0.7.0)
+Project-URL: Repository, http://github.com/swarmauri/swarmauri-sdk
+Description-Content-Type: text/markdown
+
+# Swarmauri Example Community Package

swarmauri_tool_gmail-0.6.0.dev154/README.md

@@ -0,0 +1 @@
+# Swarmauri Example Community Package

swarmauri_tool_gmail-0.6.0.dev154/pyproject.toml

@@ -0,0 +1,57 @@
+[tool.poetry]
+name = "swarmauri_tool_gmail"
+version = "0.6.0.dev154"
+description = "example community package"
+authors = ["Jacob Stewart <jacob@swarmauri.com>"]
+license = "Apache-2.0"
+readme = "README.md"
+repository = "http://github.com/swarmauri/swarmauri-sdk"
+classifiers = [
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12"
+]
+
+[tool.poetry.dependencies]
+python = ">=3.10,<3.13"
+
+# Swarmauri
+swarmauri_core = {version = "^0.6.0.dev154"}
+swarmauri_base = {version = "^0.6.0.dev154"}
+
+# Dependencies
+
+
+[tool.poetry.group.dev.dependencies]
+flake8 = "^7.0"
+pytest = "^8.0"
+pytest-asyncio = ">=0.24.0"
+pytest-xdist = "^3.6.1"
+pytest-json-report = "^1.5.0"
+python-dotenv = "*"
+requests = "^2.32.3"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+norecursedirs = ["combined", "scripts"]
+
+markers = [
+    "test: standard test",
+    "unit: Unit tests",
+    "integration: Integration tests",
+    "acceptance: Acceptance tests",
+    "experimental: Experimental tests"
+]
+log_cli = true
+log_cli_level = "INFO"
+log_cli_format = "%(asctime)s [%(levelname)s] %(message)s"
+log_cli_date_format = "%Y-%m-%d %H:%M:%S"
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.poetry.plugins."swarmauri.tools"]
+GmailSendTool = "swarmauri_tool_gmail.GmailSendTool:GmailSendTool"
+GmailReadTool = "swarmauri_tool_gmail.GmailReadTool:GmailReadTool"

swarmauri_tool_gmail-0.6.0.dev154/swarmauri_tool_gmail/GmailReadTool.py

@@ -0,0 +1,99 @@
+from google.oauth2 import service_account
+from googleapiclient.discovery import build
+from swarmauri_core.ComponentBase import ComponentBase
+from swarmauri_base.tools.ToolBase import ToolBase
+from swarmauri_standard.tools.Parameter import Parameter
+from typing import List, Literal, Dict, Optional
+from pydantic import Field
+
+
+@ComponentBase.register_type(ToolBase, "GmailReadTool")
+class GmailReadTool(ToolBase):
+    SCOPES: List[str] = ["https://www.googleapis.com/auth/gmail.readonly"]
+    version: str = "1.0.0"
+    parameters: List[Parameter] = Field(
+        default_factory=lambda: [
+            Parameter(
+                name="query",
+                type="string",
+                description="""The query to filter emails. For example, "is:unread" or "from:example@gmail.com".""",
+                required=True,
+            ),
+            Parameter(
+                name="max_results",
+                type="integer",
+                description="""The maximum number of emails to return. Defaults to 10.""",
+            ),
+        ]
+    )
+
+    name: str = "GmailReadTool"
+    description: str = "Read emails from a Gmail account."
+    type: Literal["GmailReadTool"] = "GmailReadTool"
+    credentials_path: str
+    sender_email: str
+    service: Optional[object] = None
+
+    def authenticate(self):
+        """
+        Authenticates the user and creates a Gmail API service.
+        """
+        credentials = service_account.Credentials.from_service_account_file(
+            self.credentials_path, scopes=self.SCOPES
+        )
+
+        delegated_credentials = credentials.with_subject(self.sender_email)
+        self.service = build("gmail", "v1", credentials=delegated_credentials)
+
+    def __call__(self, query: str = "", max_results: int = 10) -> Dict[str, str]:
+        """
+        Fetches emails from the authenticated Gmail account based on the given query.
+
+        Parameters:
+        query (str): The query to filter emails. For example, "is:unread".
+        max_results (int): The maximum number of email messages to fetch.
+
+        Returns:
+            Dict[str, str]: A dictionary containing the email messages.
+        """
+        try:
+            self.authenticate()
+            # Call the Gmail API
+            gmail_messages = self.service.users().messages()
+            results = gmail_messages.list(
+                userId="me", q=query, maxResults=max_results
+            ).execute()
+            messages = results.get("messages", [])
+            message_data = ""
+            for message in messages:
+                msg = gmail_messages.get(
+                    userId="me", id=message["id"], format="full"
+                ).execute()
+                headers = msg["payload"]["headers"]
+
+                sender = next(
+                    header["value"] for header in headers if header["name"] == "From"
+                )
+                subject = next(
+                    header["value"] for header in headers if header["name"] == "Subject"
+                )
+                reply_to = next(
+                    (
+                        header["value"]
+                        for header in headers
+                        if header["name"] == "Reply-To"
+                    ),
+                    subject,
+                )
+                date_time = next(
+                    header["value"] for header in headers if header["name"] == "Date"
+                )
+
+                formatted_msg = f"\nSender: {sender}\nReply-To: {reply_to}\nSubject: {subject}\nDate: {date_time}\n"
+                message_data += formatted_msg
+
+            return {"gmail_messages": message_data}
+        except Exception as e:
+            return f"An error occurred: {str(e)}"
+        finally:
+            del self.service

swarmauri_tool_gmail-0.6.0.dev154/swarmauri_tool_gmail/GmailSendTool.py

@@ -0,0 +1,104 @@
+import base64
+from email.mime.multipart import MIMEMultipart
+from email.mime.text import MIMEText
+from google.oauth2 import service_account
+from googleapiclient.discovery import build, Resource
+from swarmauri_core.ComponentBase import ComponentBase
+from swarmauri_base.tools.ToolBase import ToolBase
+from swarmauri_standard.tools.Parameter import Parameter
+from typing import List, Dict, Literal
+from pydantic import Field
+
+
+@ComponentBase.register_type(ToolBase, "GmailSendTool")
+class GmailSendTool(ToolBase):
+    SCOPES: List[str] = ["https://www.googleapis.com/auth/gmail.send"]
+
+    version: str = "1.0.0"
+    parameters: List[Parameter] = Field(
+        default_factory=lambda: [
+            Parameter(
+                name="recipients",
+                type="string",
+                description="The email addresses of the recipients, separated by commas",
+                required=True,
+            ),
+            Parameter(
+                name="subject",
+                type="string",
+                description="The subject of the email",
+                required=True,
+            ),
+            Parameter(
+                name="htmlMsg",
+                type="string",
+                description="The HTML message to be sent as the email body",
+                required=True,
+            ),
+        ]
+    )
+
+    name: str = "GmailSendTool"
+    description: str = "Sends an email using the Gmail API."
+    type: Literal["GmailSendTool"] = "GmailSendTool"
+
+    credentials_path: str
+    sender_email: str
+
+    def authenticate(self) -> Resource:
+        """
+        Authenticates the user and creates a Gmail API service for sending emails.
+        This method returns the service instance, without saving it as an attribute.
+        """
+        credentials = service_account.Credentials.from_service_account_file(
+            self.credentials_path, scopes=self.SCOPES
+        )
+        delegated_credentials = credentials.with_subject(self.sender_email)
+        return build("gmail", "v1", credentials=delegated_credentials)
+
+    def create_message(
+        self, to: str, subject: str, message_text: str
+    ) -> Dict[str, str]:
+        """
+        Create a MIMEText message for sending an email.
+
+        Parameters:
+        to (str): The email address of the recipient.
+        subject (str): The subject of the email.
+        message_text (str): The HTML body of the email.
+
+        Returns:
+        Dict[str, str]: The created MIMEText message in a format suitable for Gmail API.
+        """
+        message = MIMEMultipart("alternative")
+        message["from"] = self.sender_email
+        message["to"] = to
+        message["subject"] = subject
+        mime_text = MIMEText(message_text, "html")
+        message.attach(mime_text)
+        raw_message = base64.urlsafe_b64encode(
+            message.as_string().encode("utf-8")
+        ).decode("utf-8")
+        return {"raw": raw_message}
+
+    def __call__(self, recipients: str, subject: str, htmlMsg: str) -> Dict[str, str]:
+        """
+        Sends an email to the specified recipients with the given subject and HTML message.
+
+        Parameters:
+            recipients (str): The email address of the recipients, separated by commas.
+            subject (str): The subject of the email.
+            htmlMsg (str): The HTML content of the email body.
+
+        Returns:
+            Dict[str, str]: A message indicating the status of the email sending process.
+        """
+        service = (
+            self.authenticate()
+        )  # Authenticate within this function and do not store in the object state
+        try:
+            message = self.create_message(recipients, subject, htmlMsg)
+            service.users().messages().send(userId="me", body=message).execute()
+            return {"success": f"Email sent successfully to {recipients}"}
+        except Exception as e:
+            return {"error": f"An error occurred in sending the email: {str(e)}"}

swarmauri_tool_gmail-0.6.0.dev154/swarmauri_tool_gmail/__init__.py

@@ -0,0 +1,17 @@
+from .GmailReadTool import GmailReadTool
+from .GmailSendTool import GmailSendTool
+
+__version__ = "0.6.0.dev26"
+__long_desc__ = """
+
+# Swarmauri Gmail Plugin
+
+Components Included:
+- GmailSendTool
+- GmailReadTool
+
+Visit us at: https://swarmauri.com
+Follow us at: https://github.com/swarmauri
+Star us at: https://github.com/swarmauri/swarmauri-sdk
+
+"""