truefoundry-sdk 0.1.17rc1__tar.gz → 0.1.19__tar.gz

truefoundry_sdk-0.1.19/PKG-INFO

@@ -0,0 +1,303 @@
+Metadata-Version: 2.1
+Name: truefoundry-sdk
+Version: 0.1.19
+Summary: 
+Requires-Python: >=3.8
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+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: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: pydantic-core (>=2.18.2)
+Requires-Dist: typing_extensions (>=4.0.0)
+Project-URL: Repository, https://github.com/truefoundry/truefoundry-python-sdk
+Description-Content-Type: text/markdown
+
+# Truefoundry Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Ftruefoundry%2Ftruefoundry-python-sdk)
+[![pypi](https://img.shields.io/pypi/v/truefoundry-sdk)](https://pypi.python.org/pypi/truefoundry-sdk)
+
+This library provides convenient access to the TrueFoundry API.
+
+> [!tip]
+> You can ask questions about this SDK using DeepWiki
+> - Python: [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/truefoundry/truefoundry-python-sdk)
+> - TypeScript: [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/truefoundry/truefoundry-typescript-sdk)
+
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Pagination](#pagination)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
+## Installation
+
+```sh
+pip install truefoundry-sdk
+```
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/truefoundry/truefoundry-python-sdk/blob/HEAD/./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from truefoundry_sdk import TrueFoundry
+from truefoundry_sdk.applications import (
+    ApplicationsListRequestDeviceTypeFilter,
+    ApplicationsListRequestLifecycleStage,
+)
+
+client = TrueFoundry(
+    api_key="YOUR_API_KEY",
+    base_url="https://yourhost.com/path/to/api",
+)
+response = client.applications.list(
+    limit=10,
+    offset=0,
+    application_id="applicationId",
+    workspace_id="workspaceId",
+    application_name="applicationName",
+    fqn="fqn",
+    workspace_fqn="workspaceFqn",
+    application_type="applicationType",
+    name_search_query="nameSearchQuery",
+    environment_id="environmentId",
+    cluster_id="clusterId",
+    application_set_id="applicationSetId",
+    paused=True,
+    device_type_filter=ApplicationsListRequestDeviceTypeFilter.CPU,
+    last_deployed_by_subjects="lastDeployedBySubjects",
+    lifecycle_stage=ApplicationsListRequestLifecycleStage.ACTIVE,
+    is_recommendation_present_and_visible=True,
+)
+for item in response:
+    yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+    yield page
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client).
+
+```python
+import asyncio
+
+from truefoundry_sdk import AsyncTrueFoundry
+from truefoundry_sdk.applications import (
+    ApplicationsListRequestDeviceTypeFilter,
+    ApplicationsListRequestLifecycleStage,
+)
+
+client = AsyncTrueFoundry(
+    api_key="YOUR_API_KEY",
+    base_url="https://yourhost.com/path/to/api",
+)
+
+
+async def main() -> None:
+    response = await client.applications.list(
+        limit=10,
+        offset=0,
+        application_id="applicationId",
+        workspace_id="workspaceId",
+        application_name="applicationName",
+        fqn="fqn",
+        workspace_fqn="workspaceFqn",
+        application_type="applicationType",
+        name_search_query="nameSearchQuery",
+        environment_id="environmentId",
+        cluster_id="clusterId",
+        application_set_id="applicationSetId",
+        paused=True,
+        device_type_filter=ApplicationsListRequestDeviceTypeFilter.CPU,
+        last_deployed_by_subjects="lastDeployedBySubjects",
+        lifecycle_stage=ApplicationsListRequestLifecycleStage.ACTIVE,
+        is_recommendation_present_and_visible=True,
+    )
+    async for item in response:
+        yield item
+
+    # alternatively, you can paginate page-by-page
+    async for page in response.iter_pages():
+        yield page
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from truefoundry_sdk.core.api_error import ApiError
+
+try:
+    client.applications.list(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Pagination
+
+Paginated requests will return a `SyncPager` or `AsyncPager`, which can be used as generators for the underlying object.
+
+```python
+from truefoundry_sdk import TrueFoundry
+
+client = TrueFoundry(
+    api_key="YOUR_API_KEY",
+    base_url="https://yourhost.com/path/to/api",
+)
+response = client.users.list(
+    limit=10,
+    offset=0,
+    query="query",
+    show_invalid_users=True,
+    include_virtual_accounts="includeVirtualAccounts",
+)
+for item in response:
+    yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+    yield page
+```
+
+```python
+# You can also iterate through pages and access the typed response per page
+pager = client.users.list(...)
+for page in pager.iter_pages():
+    print(page.response)  # access the typed response for each page
+    for item in page:
+        print(item)
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from truefoundry_sdk import TrueFoundry
+
+client = TrueFoundry(
+    ...,
+)
+response = client.applications.with_raw_response.list(...)
+print(response.headers)  # access the response headers
+print(response.status_code)  # access the response status code
+print(response.data)  # access the underlying object
+pager = client.users.list(...)
+print(pager.response)  # access the typed response for the first page
+for item in pager:
+    print(item)  # access the underlying object(s)
+for page in pager.iter_pages():
+    print(page.response)  # access the typed response for each page
+    for item in page:
+        print(item)  # access the underlying object(s)
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.applications.list(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+
+from truefoundry_sdk import TrueFoundry
+
+client = TrueFoundry(
+    ...,
+    timeout=20.0,
+)
+
+
+# Override timeout for a specific method
+client.applications.list(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+
+```python
+import httpx
+from truefoundry_sdk import TrueFoundry
+
+client = TrueFoundry(
+    ...,
+    httpx_client=httpx.Client(
+        proxy="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!
+

truefoundry_sdk-0.1.19/README.md

@@ -0,0 +1,272 @@
+# Truefoundry Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Ftruefoundry%2Ftruefoundry-python-sdk)
+[![pypi](https://img.shields.io/pypi/v/truefoundry-sdk)](https://pypi.python.org/pypi/truefoundry-sdk)
+
+This library provides convenient access to the TrueFoundry API.
+
+> [!tip]
+> You can ask questions about this SDK using DeepWiki
+> - Python: [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/truefoundry/truefoundry-python-sdk)
+> - TypeScript: [![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/truefoundry/truefoundry-typescript-sdk)
+
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Pagination](#pagination)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
+## Installation
+
+```sh
+pip install truefoundry-sdk
+```
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/truefoundry/truefoundry-python-sdk/blob/HEAD/./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from truefoundry_sdk import TrueFoundry
+from truefoundry_sdk.applications import (
+    ApplicationsListRequestDeviceTypeFilter,
+    ApplicationsListRequestLifecycleStage,
+)
+
+client = TrueFoundry(
+    api_key="YOUR_API_KEY",
+    base_url="https://yourhost.com/path/to/api",
+)
+response = client.applications.list(
+    limit=10,
+    offset=0,
+    application_id="applicationId",
+    workspace_id="workspaceId",
+    application_name="applicationName",
+    fqn="fqn",
+    workspace_fqn="workspaceFqn",
+    application_type="applicationType",
+    name_search_query="nameSearchQuery",
+    environment_id="environmentId",
+    cluster_id="clusterId",
+    application_set_id="applicationSetId",
+    paused=True,
+    device_type_filter=ApplicationsListRequestDeviceTypeFilter.CPU,
+    last_deployed_by_subjects="lastDeployedBySubjects",
+    lifecycle_stage=ApplicationsListRequestLifecycleStage.ACTIVE,
+    is_recommendation_present_and_visible=True,
+)
+for item in response:
+    yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+    yield page
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client).
+
+```python
+import asyncio
+
+from truefoundry_sdk import AsyncTrueFoundry
+from truefoundry_sdk.applications import (
+    ApplicationsListRequestDeviceTypeFilter,
+    ApplicationsListRequestLifecycleStage,
+)
+
+client = AsyncTrueFoundry(
+    api_key="YOUR_API_KEY",
+    base_url="https://yourhost.com/path/to/api",
+)
+
+
+async def main() -> None:
+    response = await client.applications.list(
+        limit=10,
+        offset=0,
+        application_id="applicationId",
+        workspace_id="workspaceId",
+        application_name="applicationName",
+        fqn="fqn",
+        workspace_fqn="workspaceFqn",
+        application_type="applicationType",
+        name_search_query="nameSearchQuery",
+        environment_id="environmentId",
+        cluster_id="clusterId",
+        application_set_id="applicationSetId",
+        paused=True,
+        device_type_filter=ApplicationsListRequestDeviceTypeFilter.CPU,
+        last_deployed_by_subjects="lastDeployedBySubjects",
+        lifecycle_stage=ApplicationsListRequestLifecycleStage.ACTIVE,
+        is_recommendation_present_and_visible=True,
+    )
+    async for item in response:
+        yield item
+
+    # alternatively, you can paginate page-by-page
+    async for page in response.iter_pages():
+        yield page
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from truefoundry_sdk.core.api_error import ApiError
+
+try:
+    client.applications.list(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Pagination
+
+Paginated requests will return a `SyncPager` or `AsyncPager`, which can be used as generators for the underlying object.
+
+```python
+from truefoundry_sdk import TrueFoundry
+
+client = TrueFoundry(
+    api_key="YOUR_API_KEY",
+    base_url="https://yourhost.com/path/to/api",
+)
+response = client.users.list(
+    limit=10,
+    offset=0,
+    query="query",
+    show_invalid_users=True,
+    include_virtual_accounts="includeVirtualAccounts",
+)
+for item in response:
+    yield item
+# alternatively, you can paginate page-by-page
+for page in response.iter_pages():
+    yield page
+```
+
+```python
+# You can also iterate through pages and access the typed response per page
+pager = client.users.list(...)
+for page in pager.iter_pages():
+    print(page.response)  # access the typed response for each page
+    for item in page:
+        print(item)
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from truefoundry_sdk import TrueFoundry
+
+client = TrueFoundry(
+    ...,
+)
+response = client.applications.with_raw_response.list(...)
+print(response.headers)  # access the response headers
+print(response.status_code)  # access the response status code
+print(response.data)  # access the underlying object
+pager = client.users.list(...)
+print(pager.response)  # access the typed response for the first page
+for item in pager:
+    print(item)  # access the underlying object(s)
+for page in pager.iter_pages():
+    print(page.response)  # access the typed response for each page
+    for item in page:
+        print(item)  # access the underlying object(s)
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.applications.list(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+
+from truefoundry_sdk import TrueFoundry
+
+client = TrueFoundry(
+    ...,
+    timeout=20.0,
+)
+
+
+# Override timeout for a specific method
+client.applications.list(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+
+```python
+import httpx
+from truefoundry_sdk import TrueFoundry
+
+client = TrueFoundry(
+    ...,
+    httpx_client=httpx.Client(
+        proxy="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

truefoundry_sdk-0.1.19/pyproject.toml

@@ -0,0 +1,92 @@
+[project]
+name = "truefoundry-sdk"
+dynamic = ["version"]
+
+[tool.poetry]
+name = "truefoundry-sdk"
+version = "0.1.19"
+description = ""
+readme = "README.md"
+authors = []
+keywords = []
+
+classifiers = [
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Operating System :: OS Independent",
+    "Operating System :: POSIX",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Microsoft :: Windows",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed"
+]
+packages = [
+    { include = "truefoundry_sdk", from = "src"}
+]
+
+[tool.poetry.urls]
+Repository = 'https://github.com/truefoundry/truefoundry-python-sdk'
+
+[tool.poetry.dependencies]
+python = ">=3.8"
+httpx = ">=0.21.2"
+pydantic = ">= 1.9.2"
+pydantic-core = ">=2.18.2"
+typing_extensions = ">= 4.0.0"
+
+[tool.poetry.group.dev.dependencies]
+mypy = "==1.13.0"
+pytest = "^7.4.0"
+pytest-asyncio = "^0.23.5"
+pytest-xdist = "^3.6.1"
+python-dateutil = "^2.9.0"
+types-python-dateutil = "^2.9.0.20240316"
+Jinja2 = ">=3.1.6,<4.0.0"
+ipython = ">=8.0.0,<10.0.0"
+numpydoc = ">=1.7.0,<2.0.0"
+ruff = "==0.11.5"
+
+[tool.pytest.ini_options]
+testpaths = [ "tests" ]
+asyncio_mode = "auto"
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "F",  # pyflakes
+    "I",  # isort
+]
+ignore = [
+    "E402",  # Module level import not at top of file
+    "E501",  # Line too long
+    "E711",  # Comparison to `None` should be `cond is not None`
+    "E712",  # Avoid equality comparisons to `True`; use `if ...:` checks
+    "E721",  # Use `is` and `is not` for type comparisons, or `isinstance()` for insinstance checks
+    "E722",  # Do not use bare `except`
+    "E731",  # Do not assign a `lambda` expression, use a `def`
+    "F821",  # Undefined name
+    "F841"   # Local variable ... is assigned to but never used
+]
+
+[tool.ruff.lint.isort]
+section-order = ["future", "standard-library", "third-party", "first-party"]
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"