levelfour 0.1.0__tar.gz → 1.2.0__tar.gz

levelfour-1.2.0/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to the Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding any notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2024-present LevelFour AI, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

levelfour-1.2.0/MANIFEST.in

@@ -0,0 +1,11 @@
+prune tests
+prune examples
+prune scripts
+prune build
+prune dist
+prune .github
+exclude .pre-commit-config.yaml
+exclude .gitattributes
+exclude .fernignore
+exclude release-please-config.json
+exclude .release-please-manifest.json

levelfour-1.2.0/PKG-INFO

@@ -0,0 +1,361 @@
+Metadata-Version: 2.4
+Name: levelfour
+Version: 1.2.0
+Summary: The official Python SDK for the LevelFour API
+Author-email: LevelFour <support@levelfour.ai>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://levelfour.ai
+Project-URL: Repository, https://github.com/LevelFourAI/levelfour-python
+Project-URL: Documentation, https://levelfour.ai/docs
+Project-URL: Issues, https://github.com/LevelFourAI/levelfour-python/issues
+Project-URL: Changelog, https://github.com/LevelFourAI/levelfour-python/blob/main/CHANGELOG.md
+Keywords: levelfour,cloud,cost-optimization,finops,sdk
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx<1,>=0.24.0
+Requires-Dist: pydantic<3,>=2.0
+Provides-Extra: telemetry
+Requires-Dist: opentelemetry-api>=1.20.0; extra == "telemetry"
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.100.0; extra == "fastapi"
+Provides-Extra: django
+Requires-Dist: django>=4.0; extra == "django"
+Dynamic: license-file
+
+# LevelFour Python SDK
+
+[![CI](https://github.com/LevelFourAI/levelfour-python/actions/workflows/ci.yml/badge.svg)](https://github.com/LevelFourAI/levelfour-python/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/levelfour)](https://pypi.org/project/levelfour/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/levelfour)](https://pypi.org/project/levelfour/)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://github.com/LevelFourAI/levelfour-python/blob/main/LICENSE)
+
+The official Python SDK for the [LevelFour](https://levelfour.ai) API.
+
+## Requirements
+
+Python 3.9 or later.
+
+> **Note:** Python 3.9 reached end-of-life in October 2025. We will continue supporting it until a future major release.
+
+## Documentation
+
+API reference and package details are available at [levelfour.ai/docs](https://levelfour.ai/docs).
+
+## Installation
+
+```bash
+pip install levelfour
+```
+
+## Usage
+
+Set `LEVELFOUR_API_KEY` in your environment, or pass the key directly:
+
+```python
+from levelfour import LevelFour
+
+client = LevelFour(api_key="l4_live_...")
+# Or use LEVELFOUR_API_KEY env var:
+client = LevelFour()
+
+summary = client.recommendations.get_savings_by_provider()
+print(summary)
+```
+
+### Async
+
+```python
+from levelfour import AsyncLevelFour
+
+client = AsyncLevelFour(api_key="l4_live_...")
+summary = await client.recommendations.get_savings_by_provider()
+```
+
+### Managing Resources
+
+Both clients support context managers for proper resource cleanup:
+
+```python
+with LevelFour() as client:
+    summary = client.recommendations.get_savings_by_provider()
+
+async with AsyncLevelFour() as client:
+    summary = await client.recommendations.get_savings_by_provider()
+```
+
+## Cost alerts
+
+`client.cost_alerts` creates, changes, pauses and deletes the alerts that watch an account or a saved cost view. It ships in 0.2.0, and writes need a read-write key.
+
+```python
+from levelfour import LevelFour
+from levelfour.cost_alerts import CreateAlertRequestParams_Budget, UpdateAlertRequestParams_Budget
+from levelfour.types import AlertRecipient, BudgetRuleInput
+
+client = LevelFour()
+monthly = dict(reset="monthly", rules=[BudgetRuleInput(amount=80, unit="percent")])
+
+alert = client.cost_alerts.create_alert(
+    name="Production budget",
+    source_id="123456789012",  # an id from client.cost_alerts.list_sources()
+    params=CreateAlertRequestParams_Budget(budget=40000, **monthly),
+    recipients=[AlertRecipient(name="Ana", email="ana@example.com", member=True)],
+)
+alert_id = alert.data.id
+
+# Only the arguments you pass change. params replaces the whole rule, so send it back with the new figure.
+client.cost_alerts.update_alert(alert_id, params=UpdateAlertRequestParams_Budget(budget=50000, **monthly))
+
+client.cost_alerts.update_alert(alert_id, enabled=False)  # pause
+client.cost_alerts.update_alert(alert_id, enabled=True)  # resume
+
+# Deleting takes the alert's history with it. Pausing keeps it.
+client.cost_alerts.delete_alert(alert_id)
+```
+
+## Error Handling
+
+```python
+from levelfour import LevelFour
+from levelfour.exceptions import (
+    LevelFourError,
+    LevelFourConnectionError,
+    LevelFourTimeoutError,
+    NotFoundError,
+    RateLimitError,
+)
+
+client = LevelFour()
+try:
+    rec = client.recommendations.get(recommendation_id="abc")
+except NotFoundError:
+    print("Recommendation not found")
+except RateLimitError as e:
+    print(f"Rate limited, retry after: {e.retry_after}")
+except LevelFourTimeoutError:
+    print("Request timed out")
+except LevelFourConnectionError:
+    print("Network error")
+except LevelFourError as e:
+    print(f"{e.status_code} {e.code}: {e.message}")
+```
+
+Available exceptions: `BadRequestError` (400), `AuthenticationError` (401), `AuthorizationError` (403), `NotFoundError` (404), `ConflictError` (409), `ValidationError` (422), `RateLimitError` (429), `InternalServerError` (500), `LevelFourConnectionError` (network failure), `LevelFourTimeoutError` (timeout), `WebhookVerificationError` (webhook signature/payload error).
+
+All exceptions inherit from `LevelFourError`. Always import from `levelfour` or `levelfour.exceptions`: the `levelfour.errors` package is generated infrastructure and should not be imported directly.
+
+## Configuration
+
+```python
+client = LevelFour(
+    api_key="l4_live_...",
+    base_url="https://custom.api.com",
+    timeout=60.0,
+    max_retries=5,
+    headers={"X-Custom-Header": "value"},
+)
+```
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `api_key` | `LEVELFOUR_API_KEY` env var | API key (`l4_live_*` for production, `l4_test_*` for testing) |
+| `base_url` | `https://api.levelfour.ai` | API base URL |
+| `timeout` | `30.0` | Request timeout in seconds |
+| `max_retries` | `2` | Retry attempts for transient errors |
+| `http_client` | `None` | Custom `httpx.Client` (for proxy, mTLS, etc.) |
+| `headers` | `None` | Additional default headers |
+
+### Cloning Clients
+
+Create a modified copy of a client with `with_options()`:
+
+```python
+admin_client = client.with_options(
+    headers={"X-Admin": "1"},
+    timeout=120.0,
+)
+```
+
+## Retries
+
+The client retries failed requests on `5xx`, `429`, `408`, and `409` responses using exponential backoff with jitter. The default retry count is `2`. Disable retries with `max_retries=0`:
+
+```python
+client = LevelFour(max_retries=0)
+```
+
+Override per-request:
+
+```python
+from levelfour.core.request_options import RequestOptions
+
+result = client.recommendations.list(
+    request_options=RequestOptions(max_retries=5),
+)
+```
+
+## Timeouts
+
+The default request timeout is 30 seconds. Override at construction time or per-request:
+
+```python
+result = client.recommendations.list(
+    request_options=RequestOptions(timeout_in_seconds=10),
+)
+```
+
+## Pagination
+
+Paginated endpoints return an iterable:
+
+```python
+for item in client.recommendations.list():
+    print(item)
+```
+
+Collect all results:
+
+```python
+items = list(client.recommendations.list())
+```
+
+Async:
+
+```python
+async for item in client.recommendations.list():
+    print(item)
+```
+
+## Raw Response Access
+
+Use `.with_raw_response` on any sub-client to access HTTP headers and status codes:
+
+```python
+response = client.api_keys.with_raw_response.list()
+print(response.status_code)
+print(dict(response.headers))
+keys = response.data
+```
+
+## Webhooks
+
+Verify incoming webhook events using HMAC-SHA256:
+
+```python
+from levelfour.webhooks.verifier import WebhookVerifier
+
+verifier = WebhookVerifier("whsec_...")
+payload = verifier.verify(request.body, request.headers)
+```
+
+### Managing Webhook Endpoints
+
+```python
+endpoints = client.webhooks.list()
+
+new_endpoint = client.webhooks.register(
+    url="https://example.com/webhooks",
+    event_types=["recommendation.created"],
+)
+
+client.webhooks.delete(endpoint_id="ep_...")
+```
+
+## Framework Integrations
+
+### FastAPI
+
+```python
+from fastapi import Depends, FastAPI
+from levelfour.integrations.fastapi import LevelFourMiddleware, get_levelfour
+
+app = FastAPI()
+app.add_middleware(LevelFourMiddleware, api_key="l4_live_...")
+
+
+@app.get("/savings")
+async def get_savings(client=Depends(get_levelfour)):
+    return await client.recommendations.get_savings_by_provider()
+```
+
+### Django
+
+```python
+# settings.py
+LEVELFOUR_API_KEY = "l4_live_..."
+
+# views.py
+from levelfour.integrations.django import get_client
+
+client = get_client()
+```
+
+<details>
+<summary>OpenTelemetry</summary>
+
+Install the optional telemetry dependency:
+
+```bash
+pip install levelfour[telemetry]
+```
+
+When `opentelemetry-api` is installed, the SDK automatically instruments all HTTP requests with spans and metrics. Alternatively, pass a custom `httpx.Client` with your own transport:
+
+```python
+import httpx
+from opentelemetry.instrumentation.httpx import HTTPXClientInstrumentor
+
+instrumented_client = httpx.Client()
+HTTPXClientInstrumentor.instrument_client(instrumented_client)
+```
+
+</details>
+
+## Stability
+
+The public API surface is:
+
+- `levelfour.LevelFour` / `levelfour.AsyncLevelFour`: client classes
+- `levelfour.exceptions`: error hierarchy (`LevelFourError`, `NotFoundError`, etc.)
+- `levelfour.types`: Pydantic response models
+- `levelfour.webhooks.verifier`: webhook verification
+- `levelfour.integrations`: framework helpers (FastAPI, Django, OpenTelemetry)
+
+The `levelfour.core` and `levelfour.errors` packages are generated infrastructure. They may change without notice between versions and should not be imported directly.
+
+## Versioning
+
+This SDK follows [Semantic Versioning](https://semver.org/). While on `v0.x`, minor versions may include breaking changes. After `v1.0.0`, breaking changes will only ship in major version bumps.
+
+## Contributing
+
+See [CONTRIBUTING.md](https://github.com/LevelFourAI/levelfour-python/blob/main/CONTRIBUTING.md) for development setup and guidelines.
+
+## Security
+
+To report vulnerabilities, see [SECURITY.md](https://github.com/LevelFourAI/levelfour-python/blob/main/SECURITY.md).
+
+## Changelog
+
+See [CHANGELOG.md](https://github.com/LevelFourAI/levelfour-python/blob/main/CHANGELOG.md) for release history.
+
+## License
+
+Apache-2.0 - see [LICENSE](https://github.com/LevelFourAI/levelfour-python/blob/main/LICENSE).