cloudraker 0.1.1__tar.gz

cloudraker-0.1.1/.gitignore

@@ -0,0 +1,5 @@
+node_modules/
+.DS_Store
+__pycache__/
+*.egg-info/
+sdks/python/dist/

cloudraker-0.1.1/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.4
+Name: cloudraker
+Version: 0.1.1
+Summary: Python SDK for the CloudRaker API
+Requires-Python: >=3.9
+Requires-Dist: httpx>=0.21.2
+Requires-Dist: pydantic>=1.9.2
+Requires-Dist: typing-extensions>=4.0.0
+Description-Content-Type: text/markdown
+
+# cloudraker
+
+The official Python SDK for the [CloudRaker](https://cloudraker.com) API.
+
+## Installation
+
+```sh
+pip install cloudraker
+```
+
+## Usage
+
+```python
+from cloudraker.client import CloudRaker
+
+client = CloudRaker(token="YOUR_API_KEY")
+spaces = client.spaces.list_spaces()
+```
+
+Authenticate with an organization API key or a user access token as the
+bearer `token`.
+
+An async client is included:
+
+```python
+from cloudraker.client import AsyncCloudRaker
+
+client = AsyncCloudRaker(token="YOUR_API_KEY")
+spaces = await client.spaces.list_spaces()
+```
+
+## Error handling
+
+Failed requests raise `cloudraker.core.ApiError` with `status_code` and `body`.
+
+## Reference
+
+Per-endpoint documentation with usage snippets ships with the package —
+see `reference.md` inside the installed `cloudraker` package.

cloudraker-0.1.1/README.md

@@ -0,0 +1,39 @@
+# cloudraker
+
+The official Python SDK for the [CloudRaker](https://cloudraker.com) API.
+
+## Installation
+
+```sh
+pip install cloudraker
+```
+
+## Usage
+
+```python
+from cloudraker.client import CloudRaker
+
+client = CloudRaker(token="YOUR_API_KEY")
+spaces = client.spaces.list_spaces()
+```
+
+Authenticate with an organization API key or a user access token as the
+bearer `token`.
+
+An async client is included:
+
+```python
+from cloudraker.client import AsyncCloudRaker
+
+client = AsyncCloudRaker(token="YOUR_API_KEY")
+spaces = await client.spaces.list_spaces()
+```
+
+## Error handling
+
+Failed requests raise `cloudraker.core.ApiError` with `status_code` and `body`.
+
+## Reference
+
+Per-endpoint documentation with usage snippets ships with the package —
+see `reference.md` inside the installed `cloudraker` package.

cloudraker-0.1.1/pyproject.toml

@@ -0,0 +1,19 @@
+[project]
+name = "cloudraker"
+version = "0.1.1"
+description = "Python SDK for the CloudRaker API"
+readme = "README.md"
+requires-python = ">=3.9"
+dependencies = [
+    "httpx>=0.21.2",
+    "pydantic>=1.9.2",
+    "typing_extensions>=4.0.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/cloudraker"]
+exclude = ["src/cloudraker/tests"]

cloudraker-0.1.1/src/cloudraker/.fern/metadata.json

@@ -0,0 +1,12 @@
+{
+  "cliVersion": "5.50.4",
+  "generatorName": "fernapi/fern-python-sdk",
+  "generatorVersion": "5.20.1",
+  "generatorConfig": {
+    "client_class_name": "CloudRaker"
+  },
+  "originGitCommit": "b37ad38fbe4a65fe4aa7c815fb2fc7a9a1ea3725",
+  "originGitCommitIsDirty": false,
+  "invokedBy": "ci",
+  "ciProvider": "github"
+}

cloudraker-0.1.1/src/cloudraker/CONTRIBUTING.md

@@ -0,0 +1,125 @@
+# Contributing
+
+Thanks for your interest in contributing to this SDK! This document provides guidelines for contributing to the project.
+
+## Getting Started
+
+### Prerequisites
+
+- Python 3.9+
+- pip
+- poetry
+
+### Installation
+
+Install the project dependencies:
+
+```bash
+poetry install
+```
+
+### Building
+
+Build the project:
+
+```bash
+poetry build
+```
+
+### Testing
+
+Run the test suite:
+
+```bash
+poetry run pytest
+```
+
+### Linting and Formatting
+
+Check code style:
+
+```bash
+poetry run ruff check .
+poetry run ruff format .
+```
+
+### Type Checking
+
+Run the type checker:
+
+```bash
+poetry run mypy .
+```
+
+## About Generated Code
+
+**Important**: Most files in this SDK are automatically generated by [Fern](https://buildwithfern.com) from the API definition. Direct modifications to generated files will be overwritten the next time the SDK is generated.
+
+### Generated Files
+
+The following directories contain generated code:
+- `src/` - API client classes and types
+- Most Python files in the project
+
+### How to Customize
+
+If you need to customize the SDK, you have two options:
+
+#### Option 1: Use `.fernignore`
+
+For custom code that should persist across SDK regenerations:
+
+1. Create a `.fernignore` file in the project root
+2. Add file patterns for files you want to preserve (similar to `.gitignore` syntax)
+3. Add your custom code to those files
+
+Files listed in `.fernignore` will not be overwritten when the SDK is regenerated.
+
+For more information, see the [Fern documentation on custom code](https://buildwithfern.com/learn/sdks/overview/custom-code).
+
+#### Option 2: Contribute to the Generator
+
+If you want to change how code is generated for all users of this SDK:
+
+1. The Python SDK generator lives in the [Fern repository](https://github.com/fern-api/fern)
+2. Generator code is located at `generators/python-v2/`
+3. Follow the [Fern contributing guidelines](https://github.com/fern-api/fern/blob/main/CONTRIBUTING.md)
+4. Submit a pull request with your changes to the generator
+
+This approach is best for:
+- Bug fixes in generated code
+- New features that would benefit all users
+- Improvements to code generation patterns
+
+## Making Changes
+
+### Workflow
+
+1. Create a new branch for your changes
+2. Make your modifications
+3. Run tests to ensure nothing breaks: `poetry run pytest`
+4. Run linting and formatting: `poetry run ruff check .` and `poetry run ruff format .`
+5. Run type checking: `poetry run mypy .`
+6. Build the project: `poetry build`
+7. Commit your changes with a clear commit message
+8. Push your branch and create a pull request
+
+### Commit Messages
+
+Write clear, descriptive commit messages that explain what changed and why.
+
+### Code Style
+
+This project uses automated code formatting and linting. Run `poetry run ruff format .` and `poetry run ruff check .` before committing to ensure your code meets the project's style guidelines.
+
+## Questions or Issues?
+
+If you have questions or run into issues:
+
+1. Check the [Fern documentation](https://buildwithfern.com)
+2. Search existing [GitHub issues](https://github.com/fern-api/fern/issues)
+3. Open a new issue if your question hasn't been addressed
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the same license as the project.

cloudraker-0.1.1/src/cloudraker/README.md

@@ -0,0 +1,184 @@
+# Cloudraker 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=Cloudraker%2FPython)
+[![pypi](https://img.shields.io/pypi/v/cloudraker)](https://pypi.python.org/pypi/cloudraker)
+
+The Cloudraker Python library provides convenient access to the Cloudraker APIs from Python.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Environments](#environments)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
+## Installation
+
+```sh
+pip install cloudraker
+```
+
+## Reference
+
+A full reference for this library is available [here](./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from cloudraker import CloudRaker
+
+client = CloudRaker(
+    token="<token>",
+)
+
+client.actions.install_action()
+```
+
+## Environments
+
+This SDK allows you to configure different environments for API requests.
+
+```python
+from cloudraker import CloudRaker
+from cloudraker.environment import CloudRakerEnvironment
+
+client = CloudRaker(
+    environment=CloudRakerEnvironment.PRODUCTION,
+)
+```
+
+## 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 cloudraker import AsyncCloudRaker
+
+client = AsyncCloudRaker(
+    token="<token>",
+)
+
+
+async def main() -> None:
+    await client.actions.install_action()
+
+
+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 cloudraker.core.api_error import ApiError
+
+try:
+    client.actions.install_action()
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## 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 cloudraker import CloudRaker
+
+client = CloudRaker(...)
+response = client.actions.with_raw_response.install_action()
+print(response.headers)  # access the response headers
+print(response.status_code)  # access the response status code
+print(response.data)  # access the underlying object
+```
+
+### 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).
+
+Which status codes are retried depends on the `retryStatusCodes` generator configuration:
+
+**`legacy`** (current default): retries on
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+- [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#server_error_responses) (All server errors, including 500)
+
+**`recommended`**: retries on
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [502](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/502) (Bad Gateway)
+- [503](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/503) (Service Unavailable)
+- [504](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/504) (Gateway Timeout)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.actions.install_action(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 cloudraker import CloudRaker
+
+client = CloudRaker(..., timeout=20.0)
+
+# Override timeout for a specific method
+client.actions.install_action(request_options={
+    "timeout": 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 cloudraker import CloudRaker
+
+client = CloudRaker(
+    ...,
+    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!

cloudraker-0.1.1/src/cloudraker/__init__.py

@@ -0,0 +1,189 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+
+import typing
+from importlib import import_module
+
+if typing.TYPE_CHECKING:
+    from .types import (
+        GetHealthResponse,
+        GetHealthResponseStatus,
+        Home,
+        HomeActivityItem,
+        HomeActivityItemActor,
+        HomeActivityItemResource,
+        HomePendingApprovalsItem,
+        HomeRecentSpacesItem,
+        HomeSummary,
+        Me,
+        UserPreferences,
+        UserPreferencesLanguage,
+        WidgetToken,
+    )
+    from .errors import (
+        BadRequestError,
+        ConflictError,
+        ContentTooLargeError,
+        ForbiddenError,
+        GoneError,
+        NotFoundError,
+        UnprocessableEntityError,
+    )
+    from . import (
+        actions,
+        authorization,
+        data_objects,
+        files,
+        home,
+        me,
+        ontology,
+        organization_settings,
+        organization_templates,
+        playbooks,
+        runs,
+        search,
+        spaces,
+    )
+    from ._default_clients import DefaultAioHttpClient, DefaultAsyncHttpxClient
+    from .authorization import (
+        CheckMyAccessRequestChecksItem,
+        CreateGrantRequestResourceType,
+        CreateGrantRequestSubject,
+        DeleteGrantRequestResourceType,
+        DeleteGrantRequestSubject,
+        ListResourceGrantsRequestAssignment,
+        ListResourceGrantsRequestResourceType,
+    )
+    from .client import AsyncCloudRaker, CloudRaker
+    from .environment import CloudRakerEnvironment
+    from .me import UpdateUserPreferencesLanguage
+    from .ontology import SearchOrgOntologyRequestTypesItem, SearchSpaceOntologyRequestTypesItem
+    from .spaces import UpdateSpaceTypeRequestOntology, UpdateSpaceTypeRequestOntologyEntitiesItem
+_dynamic_imports: typing.Dict[str, str] = {
+    "AsyncCloudRaker": ".client",
+    "BadRequestError": ".errors",
+    "CheckMyAccessRequestChecksItem": ".authorization",
+    "CloudRaker": ".client",
+    "CloudRakerEnvironment": ".environment",
+    "ConflictError": ".errors",
+    "ContentTooLargeError": ".errors",
+    "CreateGrantRequestResourceType": ".authorization",
+    "CreateGrantRequestSubject": ".authorization",
+    "DefaultAioHttpClient": "._default_clients",
+    "DefaultAsyncHttpxClient": "._default_clients",
+    "DeleteGrantRequestResourceType": ".authorization",
+    "DeleteGrantRequestSubject": ".authorization",
+    "ForbiddenError": ".errors",
+    "GetHealthResponse": ".types",
+    "GetHealthResponseStatus": ".types",
+    "GoneError": ".errors",
+    "Home": ".types",
+    "HomeActivityItem": ".types",
+    "HomeActivityItemActor": ".types",
+    "HomeActivityItemResource": ".types",
+    "HomePendingApprovalsItem": ".types",
+    "HomeRecentSpacesItem": ".types",
+    "HomeSummary": ".types",
+    "ListResourceGrantsRequestAssignment": ".authorization",
+    "ListResourceGrantsRequestResourceType": ".authorization",
+    "Me": ".types",
+    "NotFoundError": ".errors",
+    "SearchOrgOntologyRequestTypesItem": ".ontology",
+    "SearchSpaceOntologyRequestTypesItem": ".ontology",
+    "UnprocessableEntityError": ".errors",
+    "UpdateSpaceTypeRequestOntology": ".spaces",
+    "UpdateSpaceTypeRequestOntologyEntitiesItem": ".spaces",
+    "UpdateUserPreferencesLanguage": ".me",
+    "UserPreferences": ".types",
+    "UserPreferencesLanguage": ".types",
+    "WidgetToken": ".types",
+    "actions": ".actions",
+    "authorization": ".authorization",
+    "data_objects": ".data_objects",
+    "files": ".files",
+    "home": ".home",
+    "me": ".me",
+    "ontology": ".ontology",
+    "organization_settings": ".organization_settings",
+    "organization_templates": ".organization_templates",
+    "playbooks": ".playbooks",
+    "runs": ".runs",
+    "search": ".search",
+    "spaces": ".spaces",
+}
+
+
+def __getattr__(attr_name: str) -> typing.Any:
+    module_name = _dynamic_imports.get(attr_name)
+    if module_name is None:
+        raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}")
+    try:
+        module = import_module(module_name, __package__)
+        if module_name == f".{attr_name}":
+            return module
+        else:
+            return getattr(module, attr_name)
+    except ImportError as e:
+        raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e
+    except AttributeError as e:
+        raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e
+
+
+def __dir__():
+    lazy_attrs = list(_dynamic_imports.keys())
+    return sorted(lazy_attrs)
+
+
+__all__ = [
+    "AsyncCloudRaker",
+    "BadRequestError",
+    "CheckMyAccessRequestChecksItem",
+    "CloudRaker",
+    "CloudRakerEnvironment",
+    "ConflictError",
+    "ContentTooLargeError",
+    "CreateGrantRequestResourceType",
+    "CreateGrantRequestSubject",
+    "DefaultAioHttpClient",
+    "DefaultAsyncHttpxClient",
+    "DeleteGrantRequestResourceType",
+    "DeleteGrantRequestSubject",
+    "ForbiddenError",
+    "GetHealthResponse",
+    "GetHealthResponseStatus",
+    "GoneError",
+    "Home",
+    "HomeActivityItem",
+    "HomeActivityItemActor",
+    "HomeActivityItemResource",
+    "HomePendingApprovalsItem",
+    "HomeRecentSpacesItem",
+    "HomeSummary",
+    "ListResourceGrantsRequestAssignment",
+    "ListResourceGrantsRequestResourceType",
+    "Me",
+    "NotFoundError",
+    "SearchOrgOntologyRequestTypesItem",
+    "SearchSpaceOntologyRequestTypesItem",
+    "UnprocessableEntityError",
+    "UpdateSpaceTypeRequestOntology",
+    "UpdateSpaceTypeRequestOntologyEntitiesItem",
+    "UpdateUserPreferencesLanguage",
+    "UserPreferences",
+    "UserPreferencesLanguage",
+    "WidgetToken",
+    "actions",
+    "authorization",
+    "data_objects",
+    "files",
+    "home",
+    "me",
+    "ontology",
+    "organization_settings",
+    "organization_templates",
+    "playbooks",
+    "runs",
+    "search",
+    "spaces",
+]

cloudraker-0.1.1/src/cloudraker/_default_clients.py

@@ -0,0 +1,30 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import httpx
+
+SDK_DEFAULT_TIMEOUT = 60
+
+try:
+    import httpx_aiohttp  # type: ignore[import-not-found]
+except ImportError:
+
+    class DefaultAioHttpClient(httpx.AsyncClient):  # type: ignore
+        def __init__(self, **kwargs: typing.Any) -> None:
+            raise RuntimeError("To use the aiohttp client, install the aiohttp extra: pip install cloudraker[aiohttp]")
+
+else:
+
+    class DefaultAioHttpClient(httpx_aiohttp.HttpxAiohttpClient):  # type: ignore
+        def __init__(self, **kwargs: typing.Any) -> None:
+            kwargs.setdefault("timeout", SDK_DEFAULT_TIMEOUT)
+            kwargs.setdefault("follow_redirects", True)
+            super().__init__(**kwargs)
+
+
+class DefaultAsyncHttpxClient(httpx.AsyncClient):
+    def __init__(self, **kwargs: typing.Any) -> None:
+        kwargs.setdefault("timeout", SDK_DEFAULT_TIMEOUT)
+        kwargs.setdefault("follow_redirects", True)
+        super().__init__(**kwargs)

cloudraker-0.1.1/src/cloudraker/actions/__init__.py

@@ -0,0 +1,4 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+