pangea-sdk: document configuration options

Author: kenany

packages/pangea-sdk/README.md

@@ -40,13 +40,13 @@ the same compatibility guarantees as stable releases.
 Via pip:
 
 ```bash
-$ pip3 install pangea-sdk==5.5.0b2
+$ pip3 install pangea-sdk==6.2.0b2
 ```
 
 Via poetry:
 
 ```bash
-$ poetry add pangea-sdk==5.5.0b2
+$ poetry add pangea-sdk==6.2.0b2
 ```
 
 ## Usage
@@ -79,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
@@ -133,14 +153,14 @@ options:
 ```
 
 It accepts multiple file formats:
+
 - a Verification Artifact from the Pangea User Console
 - a search response from the REST API:
 
 ```bash
 $ 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 +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