arcade-microsoft 0.2.3__tar.gz

arcade_microsoft-0.2.3/.gitignore

@@ -0,0 +1,175 @@
+.DS_Store
+credentials.yaml
+docker/credentials.yaml
+
+*.lock
+
+# example data
+examples/data
+scratch
+
+
+docs/source
+
+# From https://raw.githubusercontent.com/github/gitignore/main/Python.gitignore
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/

arcade_microsoft-0.2.3/.pre-commit-config.yaml

@@ -0,0 +1,18 @@
+files: ^.*/microsoft/.*
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v4.4.0"
+    hooks:
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.7
+    hooks:
+      - id: ruff
+        args: [--fix]
+      - id: ruff-format

arcade_microsoft-0.2.3/.ruff.toml

@@ -0,0 +1,44 @@
+target-version = "py310"
+line-length = 100
+fix = true
+
+[lint]
+select = [
+    # flake8-2020
+    "YTT",
+    # flake8-bandit
+    "S",
+    # flake8-bugbear
+    "B",
+    # flake8-builtins
+    "A",
+    # flake8-comprehensions
+    "C4",
+    # flake8-debugger
+    "T10",
+    # flake8-simplify
+    "SIM",
+    # isort
+    "I",
+    # mccabe
+    "C90",
+    # pycodestyle
+    "E", "W",
+    # pyflakes
+    "F",
+    # pygrep-hooks
+    "PGH",
+    # pyupgrade
+    "UP",
+    # ruff
+    "RUF",
+    # tryceratops
+    "TRY",
+]
+
+[lint.per-file-ignores]
+"**/tests/*" = ["S101"]
+
+[format]
+preview = true
+skip-magic-trailing-comma = false

arcade_microsoft-0.2.3/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025, Arcade
+
+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.

arcade_microsoft-0.2.3/Makefile

@@ -0,0 +1,55 @@
+.PHONY: help
+
+help:
+	@echo "🛠️ github Commands:\n"
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+.PHONY: install
+install: ## Install the uv environment and install all packages with dependencies
+	@echo "🚀 Creating virtual environment and installing all packages using uv"
+	@uv sync --active --all-extras --no-sources
+	@if [ -f .pre-commit-config.yaml ]; then uv run --no-sources pre-commit install; fi
+	@echo "✅ All packages and dependencies installed via uv"
+
+.PHONY: install-local
+install-local: ## Install the uv environment and install all packages with dependencies with local Arcade sources
+	@echo "🚀 Creating virtual environment and installing all packages using uv"
+	@uv sync --active --all-extras
+	@if [ -f .pre-commit-config.yaml ]; then uv run pre-commit install; fi
+	@echo "✅ All packages and dependencies installed via uv"
+
+.PHONY: build
+build: clean-build ## Build wheel file using poetry
+	@echo "🚀 Creating wheel file"
+	uv build
+
+.PHONY: clean-build
+clean-build: ## clean build artifacts
+	@echo "🗑️ Cleaning dist directory"
+	rm -rf dist
+
+.PHONY: test
+test: ## Test the code with pytest
+	@echo "🚀 Testing code: Running pytest"
+	@uv run --no-sources pytest -W ignore -v --cov --cov-config=pyproject.toml --cov-report=xml
+
+.PHONY: coverage
+coverage: ## Generate coverage report
+	@echo "coverage report"
+	@uv run --no-sources coverage report
+	@echo "Generating coverage report"
+	@uv run --no-sources coverage html
+
+.PHONY: bump-version
+bump-version: ## Bump the version in the pyproject.toml file by a patch version
+	@echo "🚀 Bumping version in pyproject.toml"
+	uv version --no-sources --bump patch
+
+.PHONY: check
+check: ## Run code quality tools.
+	@if [ -f .pre-commit-config.yaml ]; then\
+		echo "🚀 Linting code: Running pre-commit";\
+		uv run --no-sources pre-commit run -a;\
+	fi
+	@echo "🚀 Static type checking: Running mypy"
+	@uv run --no-sources mypy --config-file=pyproject.toml

arcade_microsoft-0.2.3/PKG-INFO

@@ -0,0 +1,21 @@
+Metadata-Version: 2.4
+Name: arcade_microsoft
+Version: 0.2.3
+Summary: Arcade.dev LLM tools for Outlook Mail
+Author-email: Arcade <dev@arcade.dev>
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: arcade-tdk<3.0.0,>=2.0.0
+Requires-Dist: beautifulsoup4<5.0.0,>=4.10.0
+Requires-Dist: msgraph-sdk<2.0.0,>=1.28.0
+Requires-Dist: pytz<2025.0.0,>=2024.2
+Provides-Extra: dev
+Requires-Dist: arcade-ai[evals]<3.0.0,>=2.0.0; extra == 'dev'
+Requires-Dist: arcade-serve<3.0.0,>=2.0.0; extra == 'dev'
+Requires-Dist: mypy<1.6.0,>=1.5.1; extra == 'dev'
+Requires-Dist: pre-commit<3.5.0,>=3.4.0; extra == 'dev'
+Requires-Dist: pytest-asyncio<0.25.0,>=0.24.0; extra == 'dev'
+Requires-Dist: pytest-cov<4.1.0,>=4.0.0; extra == 'dev'
+Requires-Dist: pytest<8.4.0,>=8.3.0; extra == 'dev'
+Requires-Dist: ruff<0.8.0,>=0.7.4; extra == 'dev'
+Requires-Dist: tox<4.12.0,>=4.11.1; extra == 'dev'

arcade_microsoft-0.2.3/arcade_microsoft/client.py

@@ -0,0 +1,26 @@
+import datetime
+from typing import Any
+
+from azure.core.credentials import AccessToken, TokenCredential
+from msgraph import GraphServiceClient
+
+DEFAULT_SCOPE = "https://graph.microsoft.com/.default"
+
+
+class StaticTokenCredential(TokenCredential):
+    """Implementation of TokenCredential protocol to be provided to the MSGraph SDK client"""
+
+    def __init__(self, token: str):
+        self._token = token
+
+    def get_token(self, *scopes: str, **kwargs: Any) -> AccessToken:
+        # An expiration is required by MSGraph SDK. Set to 1 hour from now.
+        expires_on = int(datetime.datetime.now(datetime.timezone.utc).timestamp()) + 3600
+        return AccessToken(self._token, expires_on)
+
+
+def get_client(token: str) -> GraphServiceClient:
+    """Create and return a MSGraph SDK client, given the provided token."""
+    token_credential = StaticTokenCredential(token)
+
+    return GraphServiceClient(token_credential, scopes=[DEFAULT_SCOPE])

arcade_microsoft-0.2.3/arcade_microsoft/outlook_calendar/__init__.py

@@ -0,0 +1,7 @@
+from arcade_microsoft.outlook_calendar.tools import (
+    create_event,
+    get_event,
+    list_events_in_time_range,
+)
+
+__all__ = ["create_event", "get_event", "list_events_in_time_range"]

arcade_microsoft-0.2.3/arcade_microsoft/outlook_calendar/_utils.py

@@ -0,0 +1,225 @@
+import re
+from datetime import datetime
+from typing import Any
+
+import pytz
+from arcade_tdk.errors import ToolExecutionError
+from kiota_abstractions.base_request_configuration import RequestConfiguration
+from kiota_abstractions.headers_collection import HeadersCollection
+from msgraph import GraphServiceClient
+from msgraph.generated.users.item.mailbox_settings.mailbox_settings_request_builder import (
+    MailboxSettingsRequestBuilder,
+)
+
+from arcade_microsoft.outlook_calendar.constants import WINDOWS_TO_IANA
+
+
+def validate_date_times(start_date_time: str, end_date_time: str) -> None:
+    """
+    Validate date times are in ISO 8601 format and
+    that end time is after start time (ignoring timezone offsets).
+
+    Args:
+        start_date_time: The start date time string to validate.
+        end_date_time: The end date time string to validate.
+
+    Raises:
+        ValueError: If the date times are not in ISO 8601 format
+        ToolExecutionError: If end time is not after start time.
+
+    Note:
+        This function ignores timezone offsets.
+    """
+    # parse into offset-aware datetimes
+    start_aware = datetime.fromisoformat(start_date_time)
+    end_aware = datetime.fromisoformat(end_date_time)
+
+    # drop tzinfo to treat both as naïve local times
+    start_naive = start_aware.replace(tzinfo=None)
+    end_naive = end_aware.replace(tzinfo=None)
+
+    if start_naive >= end_naive:
+        raise ToolExecutionError(
+            message="Start time must be before end time",
+            developer_message=(
+                f"The start time '{start_naive}' is not before the end time '{end_naive}'"
+            ),
+        )
+
+
+def prepare_meeting_body(
+    body: str, custom_meeting_url: str | None, is_online_meeting: bool
+) -> tuple[str, bool]:
+    """Prepare meeting body and determine final online meeting status.
+
+    Args:
+        body: The original meeting body text
+        custom_meeting_url: Custom URL for the meeting, if one exists
+        is_online_meeting: Whether this should be an online meeting
+
+    Returns:
+        tuple: (Updated meeting body, final online meeting status)
+
+    Note:
+        If a custom meeting URL is provided, is_online_meeting will be set to False
+        to prevent Microsoft from generating its own meeting URL. The custom meeting
+        URL will then be added to the body of the meeting.
+    """
+    is_online_meeting = not custom_meeting_url and is_online_meeting
+
+    if custom_meeting_url:
+        body = f"""{body}\n
+.........................................................................
+Join online meeting
+{custom_meeting_url}"""
+
+    return body, is_online_meeting
+
+
+def validate_emails(emails: list[str]) -> None:
+    """Validate a list of email addresses.
+
+    Args:
+        emails: The list of email addresses to validate.
+
+    Raises:
+        ToolExecutionError: If any email address is invalid.
+    """
+    invalid_emails = []
+    for email in emails:
+        if not is_valid_email(email):
+            invalid_emails.append(email)
+    if invalid_emails:
+        raise ToolExecutionError(message=f"Invalid email address(es): {', '.join(invalid_emails)}")
+
+
+def is_valid_email(email: str) -> bool:
+    """Simple check to see if an email address is valid.
+
+    Args:
+        email: The email address to check.
+
+    Returns:
+        True if the email address is valid, False otherwise.
+    """
+    pattern = r"^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$"
+    return re.match(pattern, email) is not None
+
+
+def remove_timezone_offset(date_time: str) -> str:
+    """Remove the timezone offset from the date_time string."""
+    return re.sub(r"[+-][0-9]{2}:[0-9]{2}$|Z$", "", date_time)
+
+
+def replace_timezone_offset(date_time: str, time_zone_offset: str) -> str:
+    """Replace the timezone offset in the date_time string with the time_zone_offset.
+
+    If the date_time str already contains a timezone offset, it will be replaced.
+    If the date_time str does not contain a timezone offset, the time_zone_offset will be appended
+
+    Args:
+        date_time: The date_time string to replace the timezone offset in.
+        time_zone_offset: The timezone offset to replace the existing timezone offset with.
+
+    Returns:
+        The date_time string with the timezone offset replaced or appended.
+    """
+    date_time = remove_timezone_offset(date_time)
+    return f"{date_time}{time_zone_offset}"
+
+
+def convert_timezone_to_offset(time_zone: str) -> str:
+    """
+    Convert a timezone (Windows or IANA) to ISO 8601 offset.
+    First tries Windows timezone format, then IANA, then falls back to UTC if both fail.
+
+    Args:
+        time_zone: The timezone (Windows or IANA) to convert to ISO 8601 offset.
+
+    Returns:
+        The timezone offset in ISO 8601 format (e.g. '+08:00', '-07:00', or 'Z' for UTC)
+    """
+    # Try Windows timezone format
+    iana_timezone = WINDOWS_TO_IANA.get(time_zone)
+    if iana_timezone:
+        try:
+            tz = pytz.timezone(iana_timezone)
+            now = datetime.now(tz)
+            tz_offset = now.strftime("%z")
+
+            if len(tz_offset) == 5:  # +HHMM format
+                tz_offset = f"{tz_offset[:3]}:{tz_offset[3:]}"  # +HH:MM format
+            return tz_offset  # noqa: TRY300
+        except (pytz.exceptions.UnknownTimeZoneError, ValueError):
+            pass
+
+    # Try IANA timezone format
+    try:
+        tz = pytz.timezone(time_zone)
+        now = datetime.now(tz)
+        tz_offset = now.strftime("%z")
+
+        if len(tz_offset) == 5:  # +HHMM format
+            tz_offset = f"{tz_offset[:3]}:{tz_offset[3:]}"  # +HH:MM format
+        return tz_offset  # noqa: TRY300
+    except (pytz.exceptions.UnknownTimeZoneError, ValueError):
+        # Fallback to UTC
+        return "Z"
+
+
+async def get_default_calendar_timezone(client: GraphServiceClient) -> str:
+    """Get the authenticated user's default calendar's timezone.
+
+    Args:
+        client: The GraphServiceClient to use to get
+            the authenticated user's default calendar's timezone.
+
+    Returns:
+        The timezone in "Windows timezone format" or "IANA timezone format".
+    """
+    query_params = MailboxSettingsRequestBuilder.MailboxSettingsRequestBuilderGetQueryParameters(
+        select=["timeZone"]
+    )
+    request_config = RequestConfiguration(
+        query_parameters=query_params,
+    )
+    response = await client.me.mailbox_settings.get(request_config)
+
+    if response and response.time_zone:
+        return response.time_zone
+    return "UTC"
+
+
+def create_timezone_headers(time_zone: str) -> HeadersCollection:
+    """
+    Create headers with timezone preference.
+
+    Args:
+        time_zone: The timezone to set in the headers.
+
+    Returns:
+        Headers collection with timezone preference set.
+    """
+    headers = HeadersCollection()
+    headers.try_add("Prefer", f'outlook.timezone="{time_zone}"')
+    return headers
+
+
+def create_timezone_request_config(
+    time_zone: str, query_parameters: Any | None = None
+) -> RequestConfiguration:
+    """
+    Create a request configuration with timezone headers and optional query parameters.
+
+    Args:
+        time_zone: The timezone to set in the headers.
+        query_parameters: Optional query parameters to include in the configuration.
+
+    Returns:
+        Request configuration with timezone headers and optional query parameters.
+    """
+    headers = create_timezone_headers(time_zone)
+    return RequestConfiguration(
+        headers=headers,
+        query_parameters=query_parameters,
+    )