chore: cleanup and refactor core client (#146)

* ci: no need to use yapf as we have pylint

* chore: remove MANIFEST.in since we are not using setuptools

* chore: move all files into module

* chore: update project

* docs: added instrutions on how to use just the core client

* chore: try limiting python runs to only the changed package

* Revert "chore: try limiting python runs to only the changed package"

This reverts commit e93b664.

* chore: add python core specific validation action

* chore: add build step for smoke test

Author: MIchaelMainer

.github/workflows/build-and-test-python-core.yml

@@ -0,0 +1,63 @@
+name: Build and validate Python core package
+
+on:
+  workflow_dispatch:
+  pull_request:
+    branches: ["main"]
+    paths:
+      - "python/packages/microsoft_agents_m365copilot_core/microsoft_agents_m365copilot_core/**"
+      - "python/packages/microsoft_agents_m365copilot_core/tests/**"
+      - "python/packages/microsoft_agents_m365copilot_core/pyproject.toml"
+
+permissions:
+  contents: read
+  actions: read
+  security-events: write
+
+jobs:
+  build-and-test-python-core:
+    name: python-microsoft_agents_m365copilot_core
+    runs-on: ubuntu-latest
+    strategy:
+      max-parallel: 5
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade poetry
+          poetry install
+        working-directory: python/packages/microsoft_agents_m365copilot_core
+
+      - name: Build
+        run: |
+          poetry build
+        working-directory: python/packages/microsoft_agents_m365copilot_core
+
+      - name: Check import order
+        run: |
+          poetry run isort .
+        working-directory: python/packages/microsoft_agents_m365copilot_core
+
+      - name: Run tests
+        run: |
+          poetry run pytest .
+        working-directory: python/packages/microsoft_agents_m365copilot_core
+
+      # Common CodeQL steps
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: python
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v3
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3
+        with:
+          category: "/language:python"

.github/workflows/build-and-test.yml

@@ -140,12 +140,6 @@ jobs:
         working-directory: ${{ matrix.packages.path }}
 
       # Core package specific steps
-      - name: Check code format
-        if: matrix.packages.name == 'microsoft_agents_m365copilot_core'
-        run: |
-          poetry run yapf -dr .
-        working-directory: ${{ matrix.packages.path }}
-
       - name: Check import order
         if: matrix.packages.name == 'microsoft_agents_m365copilot_core'
         run: |

python/packages/microsoft_agents_m365copilot_core/MANIFEST.in

@@ -61,22 +61,18 @@ CLIENT_ID = "YOUR_CLIENT_ID"
 
 > **Note:**
 >
-> This example shows how to make a call to the Microsoft 365 Copilot Retrieval API. To call this API, you need to install the [Microsoft 365 Copilot APIs Python Beta Client Library](https://github.com/microsoft/Agents-M365Copilot/tree/main/python/packages/microsoft_agents_m365copilot_beta), create a request object and then run the POST method on the request.
+> This example shows how to make a call to the Microsoft 365 Copilot Retrieval API using just the core library. Alternately, you can use the [Microsoft 365 Copilot APIs Python Beta Client Library](https://github.com/microsoft/Agents-M365Copilot/tree/main/python/packages/microsoft_agents_m365copilot_beta) to create a request object and then run the POST method on the request.
 
 ```python
 import asyncio
 import os
 from datetime import datetime
 
 from azure.identity import DeviceCodeCredential
-from dotenv import load_dotenv
-from kiota_abstractions.api_error import APIError
+from dotenv import load_dotenv 
 
-from microsoft_agents_m365copilot_beta import AgentsM365CopilotBetaServiceClient
-from microsoft_agents_m365copilot_beta.generated.copilot.retrieval.retrieval_post_request_body import (
-    RetrievalPostRequestBody,
-)
-from microsoft_agents_m365copilot_beta.generated.models.retrieval_data_source import RetrievalDataSource
+from microsoft_agents_m365copilot_core.src._enums import APIVersion
+from microsoft_agents_m365copilot_core.src.client_factory import  MicrosoftAgentsM365CopilotClientFactory
 
 load_dotenv()
 
@@ -96,44 +92,39 @@ credentials = DeviceCodeCredential(
     prompt_callback=auth_callback
 )
 
-# Use the Graph API beta endpoint explicitly
-scopes = ['https://graph.microsoft.com/.default']
-client = AgentsM365CopilotBetaServiceClient(credentials=credentials, scopes=scopes)
+client = MicrosoftAgentsM365CopilotClientFactory.create_with_default_middleware(api_version=APIVersion.beta)
 
-# Make sure the base URL is set to beta
-client.request_adapter.base_url = "https://graph.microsoft.com/beta"
+client.base_url = "https://graph.microsoft.com/beta" # Make sure the base URL is set to beta
 
 async def retrieve():
     try:
-        # Print the URL being used
-        print(f"Using API base URL: {client.request_adapter.base_url}\n")
-            
-        # Create the retrieval request body
-        retrieval_body = RetrievalPostRequestBody()
-        retrieval_body.data_source = RetrievalDataSource.SharePoint
-        retrieval_body.query_string = "What is the latest in my organization?"
-            
-        # Try more parameters that might be required
-        # retrieval_body.maximum_number_of_results = 10
+        # Kick off device code flow and get the token.
+        loop = asyncio.get_running_loop()
+        token = await loop.run_in_executor(None, lambda: credentials.get_token("https://graph.microsoft.com/.default"))
+
+        # Set the access token.
+        headers = {"Authorization": f"Bearer {token.token}"}
+
+        # Print the URL being used.
+        print(f"Using API base URL for incoming request: {client.base_url}\n")
+
+        # Directly use httpx to test the endpoint.
+        response = await client.post("https://graph.microsoft.com/beta/copilot/retrieval", json={
+            "queryString": "What is the latest in my organization?",
+            "dataSource": "sharePoint",
+            "resourceMetadata": [
+                "title",
+                "author"
+            ],
+            "maximumNumberOfResults": "10"
+        }, headers=headers)
+
+        # Show the response
+        print(f"Response HTTP status: {response.status_code}")
+        print(f"Response JSON content: {response.text}")
 
-        # Make the API call
-        print("Making retrieval API request...")
-        retrieval = await client.copilot.retrieval.post(retrieval_body)
-        
-        # Process the results
-        if retrieval and hasattr(retrieval, "retrieval_hits"):
-            print(f"Received {len(retrieval.retrieval_hits)} hits")
-            for r in retrieval.retrieval_hits:
-                print(f"Web URL: {r.web_url}\n")
-                for extract in r.extracts:
-                    print(f"Text:\n{extract.text}\n")
-        else:
-            print(f"Retrieval response structure: {dir(retrieval)}")
-    except APIError as e:
-        print(f"Error: {e.error.code}: {e.error.message}")
-        if hasattr(e, 'error') and hasattr(e.error, 'inner_error'):
-            print(f"Inner error details: {e.error.inner_error}")
-        raise e
+    finally:
+        print("Your call to the Copilot APIs is now complete.")
 
 # Run the async function
 asyncio.run(retrieve())