pangea-sdk 6.2.0b2__tar.gz → 6.4.0__tar.gz

pangea_sdk-6.2.0b2/README.md → pangea_sdk-6.4.0/PKG-INFO

@@ -1,3 +1,26 @@
+Metadata-Version: 2.3
+Name: pangea-sdk
+Version: 6.4.0
+Summary: Pangea API SDK
+License: MIT
+Keywords: Pangea,SDK,Audit
+Author: Glenn Gallien
+Author-email: glenn.gallien@pangea.cloud
+Requires-Python: >=3.9.2,<4.0.0
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Requires-Dist: aiohttp (>=3.12.14,<4.0.0)
+Requires-Dist: cryptography (>=45.0.5,<46.0.0)
+Requires-Dist: deprecated (>=1.2.18,<2.0.0)
+Requires-Dist: google-crc32c (>=1.7.1,<2.0.0)
+Requires-Dist: pydantic (>=2.11.7,<3.0.0)
+Requires-Dist: python-dateutil (>=2.9.0.post0,<3.0.0)
+Requires-Dist: requests (>=2.32.4,<3.0.0)
+Requires-Dist: requests-toolbelt (>=1.0.0,<2.0.0)
+Requires-Dist: typing-extensions (>=4.14.1,<5.0.0)
+Requires-Dist: yarl (>=1.20.1,<2.0.0)
+Description-Content-Type: text/markdown
+
 <a href="https://pangea.cloud?utm_source=github&utm_medium=python-sdk" target="_blank" rel="noopener noreferrer">
   <img src="https://pangea-marketing.s3.us-west-2.amazonaws.com/pangea-color.svg" alt="Pangea Logo" height="40" />
 </a>
@@ -79,6 +102,26 @@ audit = Audit(token, config)
 response = audit.log(message="Hello, World!")
 ```
 
+## Configuration
+
+The SDK supports the following configuration options via `PangeaConfig`:
+
+- `base_url_template` — Template for constructing the base URL for API requests.
+  The placeholder `{SERVICE_NAME}` will be replaced with the service name slug.
+  This is a more powerful version of `domain` that allows for setting more than
+  just the host of the API server. Defaults to
+  `https://{SERVICE_NAME}.aws.us.pangea.cloud`.
+- `domain` — Base domain for API requests. This is a weaker version of
+  `base_url_template` that only allows for setting the host of the API server.
+  Use `base_url_template` for more control over the URL, such as setting
+  service-specific paths. Defaults to `aws.us.pangea.cloud`.
+- `request_retries` — Number of retries on the initial request.
+- `request_backoff` — Backoff strategy passed to 'requests'.
+- `request_timeout` — Timeout used on initial request attempts.
+- `poll_result_timeout` — Timeout used to poll results after 202 (in secs).
+- `queued_retry_enabled` — Enable queued request retry support.
+- `custom_user_agent` — Custom user agent to be used in the request headers.
+
 ## asyncio support
 
 asyncio support is available through the `pangea.asyncio.services` module. The
@@ -133,6 +176,7 @@ options:
 ```
 
 It accepts multiple file formats:
+
 - a Verification Artifact from the Pangea User Console
 - a search response from the REST API:
 
@@ -140,7 +184,6 @@ It accepts multiple file formats:
 $ curl -H "Authorization: Bearer ${PANGEA_TOKEN}" -X POST -H 'Content-Type: application/json'  --data '{"verbose": true}' https://audit.aws.us.pangea.cloud/v1/search
 ```
 
-
 ### Bulk Download Audit Data
 
 Download all audit logs for a given time range. Start and end date should be provided,
@@ -190,14 +233,14 @@ options:
 ```
 
 It accepts multiple file formats:
+
 - a Verification Artifact from the Pangea User Console
 - a file generated by the `dump_audit` command
 - a search response from the REST API (see `verify_audit`)
 
+  [Documentation]: https://pangea.cloud/docs/sdk/python/
+  [GA Examples]: https://github.com/pangeacyber/pangea-python/tree/main/examples
+  [Beta Examples]: https://github.com/pangeacyber/pangea-python/tree/beta/examples
+  [Pangea Console]: https://console.pangea.cloud/
+  [Secure Audit Log]: https://pangea.cloud/docs/audit
 
-
-   [Documentation]: https://pangea.cloud/docs/sdk/python/
-   [GA Examples]: https://github.com/pangeacyber/pangea-python/tree/main/examples
-   [Beta Examples]: https://github.com/pangeacyber/pangea-python/tree/beta/examples
-   [Pangea Console]: https://console.pangea.cloud/
-   [Secure Audit Log]: https://pangea.cloud/docs/audit

pangea_sdk-6.2.0b2/PKG-INFO → pangea_sdk-6.4.0/README.md

@@ -1,26 +1,3 @@
-Metadata-Version: 2.3
-Name: pangea-sdk
-Version: 6.2.0b2
-Summary: Pangea API SDK
-License: MIT
-Keywords: Pangea,SDK,Audit
-Author: Glenn Gallien
-Author-email: glenn.gallien@pangea.cloud
-Requires-Python: >=3.9.2,<4.0.0
-Classifier: Topic :: Software Development
-Classifier: Topic :: Software Development :: Libraries
-Requires-Dist: aiohttp (>=3.11.18,<4.0.0)
-Requires-Dist: cryptography (>=45.0.2,<46.0.0)
-Requires-Dist: deprecated (>=1.2.18,<2.0.0)
-Requires-Dist: google-crc32c (>=1.7.1,<2.0.0)
-Requires-Dist: pydantic (>=2.11.4,<3.0.0)
-Requires-Dist: python-dateutil (>=2.9.0.post0,<3.0.0)
-Requires-Dist: requests (>=2.32.3,<3.0.0)
-Requires-Dist: requests-toolbelt (>=1.0.0,<2.0.0)
-Requires-Dist: typing-extensions (>=4.13.2,<5.0.0)
-Requires-Dist: yarl (>=1.20.0,<2.0.0)
-Description-Content-Type: text/markdown
-
 <a href="https://pangea.cloud?utm_source=github&utm_medium=python-sdk" target="_blank" rel="noopener noreferrer">
   <img src="https://pangea-marketing.s3.us-west-2.amazonaws.com/pangea-color.svg" alt="Pangea Logo" height="40" />
 </a>
@@ -102,6 +79,26 @@ audit = Audit(token, config)
 response = audit.log(message="Hello, World!")
 ```
 
+## Configuration
+
+The SDK supports the following configuration options via `PangeaConfig`:
+
+- `base_url_template` — Template for constructing the base URL for API requests.
+  The placeholder `{SERVICE_NAME}` will be replaced with the service name slug.
+  This is a more powerful version of `domain` that allows for setting more than
+  just the host of the API server. Defaults to
+  `https://{SERVICE_NAME}.aws.us.pangea.cloud`.
+- `domain` — Base domain for API requests. This is a weaker version of
+  `base_url_template` that only allows for setting the host of the API server.
+  Use `base_url_template` for more control over the URL, such as setting
+  service-specific paths. Defaults to `aws.us.pangea.cloud`.
+- `request_retries` — Number of retries on the initial request.
+- `request_backoff` — Backoff strategy passed to 'requests'.
+- `request_timeout` — Timeout used on initial request attempts.
+- `poll_result_timeout` — Timeout used to poll results after 202 (in secs).
+- `queued_retry_enabled` — Enable queued request retry support.
+- `custom_user_agent` — Custom user agent to be used in the request headers.
+
 ## asyncio support
 
 asyncio support is available through the `pangea.asyncio.services` module. The
@@ -156,6 +153,7 @@ options:
 ```
 
 It accepts multiple file formats:
+
 - a Verification Artifact from the Pangea User Console
 - a search response from the REST API:
 
@@ -163,7 +161,6 @@ It accepts multiple file formats:
 $ curl -H "Authorization: Bearer ${PANGEA_TOKEN}" -X POST -H 'Content-Type: application/json'  --data '{"verbose": true}' https://audit.aws.us.pangea.cloud/v1/search
 ```
 
-
 ### Bulk Download Audit Data
 
 Download all audit logs for a given time range. Start and end date should be provided,
@@ -213,15 +210,13 @@ options:
 ```
 
 It accepts multiple file formats:
+
 - a Verification Artifact from the Pangea User Console
 - a file generated by the `dump_audit` command
 - a search response from the REST API (see `verify_audit`)
 
-
-
-   [Documentation]: https://pangea.cloud/docs/sdk/python/
-   [GA Examples]: https://github.com/pangeacyber/pangea-python/tree/main/examples
-   [Beta Examples]: https://github.com/pangeacyber/pangea-python/tree/beta/examples
-   [Pangea Console]: https://console.pangea.cloud/
-   [Secure Audit Log]: https://pangea.cloud/docs/audit
-
+  [Documentation]: https://pangea.cloud/docs/sdk/python/
+  [GA Examples]: https://github.com/pangeacyber/pangea-python/tree/main/examples
+  [Beta Examples]: https://github.com/pangeacyber/pangea-python/tree/beta/examples
+  [Pangea Console]: https://console.pangea.cloud/
+  [Secure Audit Log]: https://pangea.cloud/docs/audit

{pangea_sdk-6.2.0b2 → pangea_sdk-6.4.0}/pangea/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "6.2.0beta2"
+__version__ = "6.4.0"
 
 from pangea.asyncio.request import PangeaRequestAsync
 from pangea.config import PangeaConfig

{pangea_sdk-6.2.0b2 → pangea_sdk-6.4.0}/pangea/asyncio/request.py

@@ -10,13 +10,13 @@ import asyncio
 import json
 import time
 from collections.abc import Iterable, Mapping
-from typing import Dict, List, Optional, Sequence, Tuple, Type, Union, cast, overload
+from typing import Dict, List, Optional, Sequence, Tuple, Type, Union, cast
 
 import aiohttp
 from aiohttp import FormData
-from pydantic import BaseModel, TypeAdapter
+from pydantic import BaseModel
 from pydantic_core import to_jsonable_python
-from typing_extensions import Any, Literal, TypeAlias, TypeVar, override
+from typing_extensions import Any, TypeAlias, TypeVar, override
 
 import pangea.exceptions as pe
 from pangea.request import MultipartResponse, PangeaRequestBase
@@ -32,6 +32,10 @@ _FileSpecTuple3: TypeAlias = tuple[_FileName, _FileContent, _FileContentType]
 _FileSpecTuple4: TypeAlias = tuple[_FileName, _FileContent, _FileContentType, _FileCustomHeaders]
 _FileSpec: TypeAlias = Union[_FileContent, _FileSpecTuple2, _FileSpecTuple3, _FileSpecTuple4]
 _Files: TypeAlias = Union[Mapping[str, _FileSpec], Iterable[tuple[str, _FileSpec]]]
+_LooseHeaders = Union[
+    Mapping[str, str],
+    Iterable[tuple[str, str]],
+]
 
 
 TResult = TypeVar("TResult", bound=PangeaResponseResult)
@@ -46,24 +50,6 @@ class PangeaRequestAsync(PangeaRequestBase):
     be set in PangeaConfig.
     """
 
-    async def delete(self, endpoint: str) -> None:
-        """
-        Makes a DELETE call to a Pangea endpoint.
-
-        Args:
-            endpoint: The Pangea API endpoint.
-        """
-
-        url = self._url(endpoint)
-
-        self.logger.debug(
-            json.dumps({"service": self.service, "action": "delete", "url": url}, default=default_encoder)
-        )
-
-        requests_response = await self._http_delete(url, headers=self._headers())
-        await self._check_http_errors(requests_response)
-
-    @overload
     async def post(
         self,
         endpoint: str,
@@ -72,60 +58,18 @@ class PangeaRequestAsync(PangeaRequestBase):
         files: Optional[List[Tuple]] = None,
         poll_result: bool = True,
         url: Optional[str] = None,
-        *,
-        pangea_response: Literal[True] = True,
     ) -> PangeaResponse[TResult]:
-        """
-        Makes a POST call to a Pangea Service endpoint.
+        """Makes the POST call to a Pangea Service endpoint.
 
         Args:
-            endpoint: The Pangea Service API endpoint.
-            data: The POST body payload object
+            endpoint(str): The Pangea Service API endpoint.
+            data(dict): The POST body payload object
 
         Returns:
             PangeaResponse which contains the response in its entirety and
                various properties to retrieve individual fields
         """
 
-    @overload
-    async def post(
-        self,
-        endpoint: str,
-        result_class: Type[TResult],
-        data: str | BaseModel | Mapping[str, Any] | None = None,
-        files: Optional[List[Tuple]] = None,
-        poll_result: bool = True,
-        url: Optional[str] = None,
-        *,
-        pangea_response: Literal[False],
-    ) -> TResult:
-        """
-        Makes a POST call to a Pangea Service endpoint.
-
-        Args:
-            endpoint: The Pangea Service API endpoint.
-            data: The POST body payload object
-        """
-
-    async def post(
-        self,
-        endpoint: str,
-        result_class: Type[TResult],
-        data: str | BaseModel | Mapping[str, Any] | None = None,
-        files: Optional[List[Tuple]] = None,
-        poll_result: bool = True,
-        url: Optional[str] = None,
-        *,
-        pangea_response: bool = True,
-    ) -> PangeaResponse[TResult] | TResult:
-        """
-        Makes a POST call to a Pangea Service endpoint.
-
-        Args:
-            endpoint: The Pangea Service API endpoint.
-            data: The POST body payload object
-        """
-
         if isinstance(data, BaseModel):
             data = data.model_dump(exclude_none=True)
 
@@ -165,13 +109,9 @@ class PangeaRequestAsync(PangeaRequestBase):
 
         await self._check_http_errors(requests_response)
 
-        if not pangea_response:
-            type_adapter = TypeAdapter(result_class)
-            return type_adapter.validate_python(await requests_response.json())
-
         if "multipart/form-data" in requests_response.headers.get("content-type", ""):
             multipart_response = await self._process_multipart_response(requests_response)
-            pangea_response_obj: PangeaResponse = PangeaResponse(
+            pangea_response: PangeaResponse = PangeaResponse(
                 requests_response,
                 result_class=result_class,
                 json=multipart_response.pangea_json,
@@ -184,110 +124,49 @@ class PangeaRequestAsync(PangeaRequestBase):
                     json.dumps({"service": self.service, "action": "post", "url": url, "response": json_resp})
                 )
 
-                pangea_response_obj = PangeaResponse(requests_response, result_class=result_class, json=json_resp)
+                pangea_response = PangeaResponse(requests_response, result_class=result_class, json=json_resp)
             except aiohttp.ContentTypeError as e:
                 raise pe.PangeaException(
                     f"Failed to decode json response. {e}. Body: {await requests_response.text()}"
                 ) from e
 
         if poll_result:
-            pangea_response_obj = await self._handle_queued_result(pangea_response_obj)
+            pangea_response = await self._handle_queued_result(pangea_response)
 
-        return self._check_response(pangea_response_obj)
+        return self._check_response(pangea_response)
 
-    @overload
-    async def get(
-        self,
-        path: str,
-        result_class: Type[TResult],
-        check_response: bool = True,
-        *,
-        params: (
-            Mapping[str | bytes | int | float, str | bytes | int | float | Iterable[str | bytes | int | float] | None]
-            | None
-        ) = None,
-        pangea_response: Literal[True] = True,
-    ) -> PangeaResponse[TResult]:
-        """
-        Makes the GET call to a Pangea Service endpoint.
+    async def get(self, path: str, result_class: Type[TResult], check_response: bool = True) -> PangeaResponse[TResult]:
+        """Makes the GET call to a Pangea Service endpoint.
 
         Args:
-            path: Additional URL path
-            params: Dictionary of querystring data to attach to the request
+            endpoint(str): The Pangea Service API endpoint.
+            path(str): Additional URL path
 
         Returns:
             PangeaResponse which contains the response in its entirety and
                various properties to retrieve individual fields
         """
 
-    @overload
-    async def get(
-        self,
-        path: str,
-        result_class: Type[TResult],
-        check_response: bool = True,
-        *,
-        params: (
-            Mapping[str | bytes | int | float, str | bytes | int | float | Iterable[str | bytes | int | float] | None]
-            | None
-        ) = None,
-        pangea_response: Literal[False] = False,
-    ) -> TResult:
-        """
-        Makes the GET call to a Pangea Service endpoint.
-
-        Args:
-            path: Additional URL path
-            params: Dictionary of querystring data to attach to the request
-        """
-
-    async def get(
-        self,
-        path: str,
-        result_class: Type[TResult],
-        check_response: bool = True,
-        *,
-        params: (
-            Mapping[str | bytes | int | float, str | bytes | int | float | Iterable[str | bytes | int | float] | None]
-            | None
-        ) = None,
-        pangea_response: bool = True,
-    ) -> PangeaResponse[TResult] | TResult:
-        """
-        Makes the GET call to a Pangea Service endpoint.
-
-        Args:
-            path: Additional URL path
-            params: Dictionary of querystring data to attach to the request
-            pangea_response: Whether or not the response body follows Pangea's
-              standard response schema
-        """
-
         url = self._url(path)
         self.logger.debug(json.dumps({"service": self.service, "action": "get", "url": url}))
 
-        async with self.session.get(url, params=params, headers=self._headers()) as requests_response:
+        async with self.session.get(url, headers=self._headers()) as requests_response:
             await self._check_http_errors(requests_response)
-
-            if not pangea_response:
-                type_adapter = TypeAdapter(result_class)
-                return type_adapter.validate_python(await requests_response.json())
-
-            pangea_response_obj = PangeaResponse(
+            pangea_response = PangeaResponse(
                 requests_response, result_class=result_class, json=await requests_response.json()
             )
 
         self.logger.debug(
             json.dumps(
-                {"service": self.service, "action": "get", "url": url, "response": pangea_response_obj.json},
+                {"service": self.service, "action": "get", "url": url, "response": pangea_response.json},
                 default=default_encoder,
             )
         )
 
         if check_response is False:
-            return pangea_response_obj
+            return pangea_response
 
-        return self._check_response(pangea_response_obj)
+        return self._check_response(pangea_response)
 
     async def _check_http_errors(self, resp: aiohttp.ClientResponse):
         if resp.status == 503:
@@ -421,18 +300,10 @@ class PangeaRequestAsync(PangeaRequestBase):
         attached_files = await self._get_attached_files(multipart_reader)
         return MultipartResponse(pangea_json, attached_files)  # type: ignore[arg-type]
 
-    async def _http_delete(
-        self,
-        url: str,
-        *,
-        headers: Mapping[str, str | bytes | None] = {},
-    ) -> aiohttp.ClientResponse:
-        return await self.session.delete(url, headers=headers)
-
     async def _http_post(
         self,
         url: str,
-        headers: Mapping[str, str] = {},
+        headers: _LooseHeaders = {},  # noqa: B006
         data: str | dict[str, Any] | None = None,
         files: _Files | None = None,
         presigned_url_post: bool = False,
@@ -469,7 +340,7 @@ class PangeaRequestAsync(PangeaRequestBase):
         self,
         url: str,
         files: Sequence[Tuple],
-        headers: Mapping[str, str] = {},
+        headers: _LooseHeaders = {},  # noqa: B006
     ) -> aiohttp.ClientResponse:
         self.logger.debug(
             json.dumps({"service": self.service, "action": "http_put", "url": url}, default=default_encoder)

{pangea_sdk-6.2.0b2 → pangea_sdk-6.4.0}/pangea/asyncio/services/__init__.py

@@ -7,7 +7,6 @@ from .authz import AuthZAsync
 from .embargo import EmbargoAsync
 from .file_scan import FileScanAsync
 from .intel import DomainIntelAsync, FileIntelAsync, IpIntelAsync, UrlIntelAsync, UserIntelAsync
-from .management import ManagementAsync
 from .prompt_guard import PromptGuardAsync
 from .redact import RedactAsync
 from .sanitize import SanitizeAsync