casedev 0.1.0__py3-none-any.whl

casedev/types/workflows/v1_list_response.py

@@ -0,0 +1,37 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["V1ListResponse", "Workflow"]
+
+
+class Workflow(BaseModel):
+    id: Optional[str] = None
+
+    created_at: Optional[str] = FieldInfo(alias="createdAt", default=None)
+
+    deployed_at: Optional[str] = FieldInfo(alias="deployedAt", default=None)
+
+    description: Optional[str] = None
+
+    name: Optional[str] = None
+
+    trigger_type: Optional[str] = FieldInfo(alias="triggerType", default=None)
+
+    updated_at: Optional[str] = FieldInfo(alias="updatedAt", default=None)
+
+    visibility: Optional[str] = None
+
+
+class V1ListResponse(BaseModel):
+    limit: Optional[int] = None
+
+    offset: Optional[int] = None
+
+    total: Optional[int] = None
+
+    workflows: Optional[List[Workflow]] = None

casedev/types/workflows/v1_retrieve_execution_response.py

@@ -0,0 +1,31 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["V1RetrieveExecutionResponse"]
+
+
+class V1RetrieveExecutionResponse(BaseModel):
+    id: Optional[str] = None
+
+    completed_at: Optional[str] = FieldInfo(alias="completedAt", default=None)
+
+    duration_ms: Optional[int] = FieldInfo(alias="durationMs", default=None)
+
+    error: Optional[str] = None
+
+    input: Optional[object] = None
+
+    output: Optional[object] = None
+
+    started_at: Optional[str] = FieldInfo(alias="startedAt", default=None)
+
+    status: Optional[str] = None
+
+    trigger_type: Optional[str] = FieldInfo(alias="triggerType", default=None)
+
+    workflow_id: Optional[str] = FieldInfo(alias="workflowId", default=None)

casedev/types/workflows/v1_retrieve_response.py

@@ -0,0 +1,35 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import List, Optional
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["V1RetrieveResponse"]
+
+
+class V1RetrieveResponse(BaseModel):
+    id: Optional[str] = None
+
+    created_at: Optional[str] = FieldInfo(alias="createdAt", default=None)
+
+    deployed_at: Optional[str] = FieldInfo(alias="deployedAt", default=None)
+
+    deployment_url: Optional[str] = FieldInfo(alias="deploymentUrl", default=None)
+
+    description: Optional[str] = None
+
+    edges: Optional[List[object]] = None
+
+    name: Optional[str] = None
+
+    nodes: Optional[List[object]] = None
+
+    trigger_config: Optional[object] = FieldInfo(alias="triggerConfig", default=None)
+
+    trigger_type: Optional[str] = FieldInfo(alias="triggerType", default=None)
+
+    updated_at: Optional[str] = FieldInfo(alias="updatedAt", default=None)
+
+    visibility: Optional[str] = None

casedev/types/workflows/v1_undeploy_response.py

@@ -0,0 +1,13 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from ..._models import BaseModel
+
+__all__ = ["V1UndeployResponse"]
+
+
+class V1UndeployResponse(BaseModel):
+    message: Optional[str] = None
+
+    success: Optional[bool] = None

casedev/types/workflows/v1_update_params.py

@@ -0,0 +1,26 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Iterable
+from typing_extensions import Literal, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["V1UpdateParams"]
+
+
+class V1UpdateParams(TypedDict, total=False):
+    description: str
+
+    edges: Iterable[object]
+
+    name: str
+
+    nodes: Iterable[object]
+
+    trigger_config: Annotated[object, PropertyInfo(alias="triggerConfig")]
+
+    trigger_type: Annotated[Literal["manual", "webhook", "schedule", "vault_upload"], PropertyInfo(alias="triggerType")]
+
+    visibility: Literal["private", "org", "public"]

casedev/types/workflows/v1_update_response.py

@@ -0,0 +1,17 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from pydantic import Field as FieldInfo
+
+from ..._models import BaseModel
+
+__all__ = ["V1UpdateResponse"]
+
+
+class V1UpdateResponse(BaseModel):
+    id: Optional[str] = None
+
+    name: Optional[str] = None
+
+    updated_at: Optional[str] = FieldInfo(alias="updatedAt", default=None)

casedev-0.1.0.dist-info/METADATA

@@ -0,0 +1,454 @@
+Metadata-Version: 2.3
+Name: casedev
+Version: 0.1.0
+Summary: The official Python library for the casedev API
+Project-URL: Homepage, https://github.com/CaseMark/casedev-python
+Project-URL: Repository, https://github.com/CaseMark/casedev-python
+Author-email: Casedev <support@casemark.com>
+License: Apache-2.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+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 :: 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: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: anyio<5,>=3.5.0
+Requires-Dist: distro<2,>=1.7.0
+Requires-Dist: httpx<1,>=0.23.0
+Requires-Dist: pydantic<3,>=1.9.0
+Requires-Dist: sniffio
+Requires-Dist: typing-extensions<5,>=4.10
+Provides-Extra: aiohttp
+Requires-Dist: aiohttp; extra == 'aiohttp'
+Requires-Dist: httpx-aiohttp>=0.1.9; extra == 'aiohttp'
+Description-Content-Type: text/markdown
+
+# Casedev Python API library
+
+<!-- prettier-ignore -->
+[![PyPI version](https://img.shields.io/pypi/v/casedev.svg?label=pypi%20(stable))](https://pypi.org/project/casedev/)
+
+The Casedev Python library provides convenient access to the Casedev REST API from any Python 3.9+
+application. The library includes type definitions for all request params and response fields,
+and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
+
+It is generated with [Stainless](https://www.stainless.com/).
+
+## Documentation
+
+The REST API documentation can be found on [docs.case.dev](https://docs.case.dev). The full API of this library can be found in [api.md](https://github.com/CaseMark/casedev-python/tree/main/api.md).
+
+## Installation
+
+```sh
+# install from the production repo
+pip install git+ssh://git@github.com/CaseMark/casedev-python.git
+```
+
+> [!NOTE]
+> Once this package is [published to PyPI](https://www.stainless.com/docs/guides/publish), this will become: `pip install casedev`
+
+## Usage
+
+The full API of this library can be found in [api.md](https://github.com/CaseMark/casedev-python/tree/main/api.md).
+
+```python
+import os
+from casedev import Casedev
+
+client = Casedev(
+    api_key=os.environ.get("CASEDEV_API_KEY"),  # This is the default and can be omitted
+    # defaults to "production".
+    environment="local",
+)
+
+response = client.llm.v1.chat.create_completion(
+    messages=[
+        {
+            "role": "user",
+            "content": "Hello!",
+        }
+    ],
+)
+print(response.id)
+```
+
+While you can provide an `api_key` keyword argument,
+we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
+to add `CASEDEV_API_KEY="My API Key"` to your `.env` file
+so that your API Key is not stored in source control.
+
+## Async usage
+
+Simply import `AsyncCasedev` instead of `Casedev` and use `await` with each API call:
+
+```python
+import os
+import asyncio
+from casedev import AsyncCasedev
+
+client = AsyncCasedev(
+    api_key=os.environ.get("CASEDEV_API_KEY"),  # This is the default and can be omitted
+    # defaults to "production".
+    environment="local",
+)
+
+
+async def main() -> None:
+    response = await client.llm.v1.chat.create_completion(
+        messages=[
+            {
+                "role": "user",
+                "content": "Hello!",
+            }
+        ],
+    )
+    print(response.id)
+
+
+asyncio.run(main())
+```
+
+Functionality between the synchronous and asynchronous clients is otherwise identical.
+
+### With aiohttp
+
+By default, the async client uses `httpx` for HTTP requests. However, for improved concurrency performance you may also use `aiohttp` as the HTTP backend.
+
+You can enable this by installing `aiohttp`:
+
+```sh
+# install from the production repo
+pip install 'casedev[aiohttp] @ git+ssh://git@github.com/CaseMark/casedev-python.git'
+```
+
+Then you can enable it by instantiating the client with `http_client=DefaultAioHttpClient()`:
+
+```python
+import os
+import asyncio
+from casedev import DefaultAioHttpClient
+from casedev import AsyncCasedev
+
+
+async def main() -> None:
+    async with AsyncCasedev(
+        api_key=os.environ.get("CASEDEV_API_KEY"),  # This is the default and can be omitted
+        http_client=DefaultAioHttpClient(),
+    ) as client:
+        response = await client.llm.v1.chat.create_completion(
+            messages=[
+                {
+                    "role": "user",
+                    "content": "Hello!",
+                }
+            ],
+        )
+        print(response.id)
+
+
+asyncio.run(main())
+```
+
+## Using types
+
+Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:
+
+- Serializing back into JSON, `model.to_json()`
+- Converting to a dictionary, `model.to_dict()`
+
+Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
+
+## Nested params
+
+Nested parameters are dictionaries, typed using `TypedDict`, for example:
+
+```python
+from casedev import Casedev
+
+client = Casedev()
+
+response = client.compute.v1.deploy(
+    entrypoint_name="entrypointName",
+    type="task",
+    config={},
+)
+print(response.config)
+```
+
+## Handling errors
+
+When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `casedev.APIConnectionError` is raised.
+
+When the API returns a non-success status code (that is, 4xx or 5xx
+response), a subclass of `casedev.APIStatusError` is raised, containing `status_code` and `response` properties.
+
+All errors inherit from `casedev.APIError`.
+
+```python
+import casedev
+from casedev import Casedev
+
+client = Casedev()
+
+try:
+    client.vault.create(
+        name="My Vault",
+    )
+except casedev.APIConnectionError as e:
+    print("The server could not be reached")
+    print(e.__cause__)  # an underlying Exception, likely raised within httpx.
+except casedev.RateLimitError as e:
+    print("A 429 status code was received; we should back off a bit.")
+except casedev.APIStatusError as e:
+    print("Another non-200-range status code was received")
+    print(e.status_code)
+    print(e.response)
+```
+
+Error codes are as follows:
+
+| Status Code | Error Type                 |
+| ----------- | -------------------------- |
+| 400         | `BadRequestError`          |
+| 401         | `AuthenticationError`      |
+| 403         | `PermissionDeniedError`    |
+| 404         | `NotFoundError`            |
+| 422         | `UnprocessableEntityError` |
+| 429         | `RateLimitError`           |
+| >=500       | `InternalServerError`      |
+| N/A         | `APIConnectionError`       |
+
+### Retries
+
+Certain errors are automatically retried 2 times by default, with a short exponential backoff.
+Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
+429 Rate Limit, and >=500 Internal errors are all retried by default.
+
+You can use the `max_retries` option to configure or disable retry settings:
+
+```python
+from casedev import Casedev
+
+# Configure the default for all requests:
+client = Casedev(
+    # default is 2
+    max_retries=0,
+)
+
+# Or, configure per-request:
+client.with_options(max_retries=5).vault.create(
+    name="My Vault",
+)
+```
+
+### Timeouts
+
+By default requests time out after 1 minute. You can configure this with a `timeout` option,
+which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/timeouts/#fine-tuning-the-configuration) object:
+
+```python
+from casedev import Casedev
+
+# Configure the default for all requests:
+client = Casedev(
+    # 20 seconds (default is 1 minute)
+    timeout=20.0,
+)
+
+# More granular control:
+client = Casedev(
+    timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
+)
+
+# Override per-request:
+client.with_options(timeout=5.0).vault.create(
+    name="My Vault",
+)
+```
+
+On timeout, an `APITimeoutError` is thrown.
+
+Note that requests that time out are [retried twice by default](https://github.com/CaseMark/casedev-python/tree/main/#retries).
+
+## Advanced
+
+### Logging
+
+We use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.
+
+You can enable logging by setting the environment variable `CASEDEV_LOG` to `info`.
+
+```shell
+$ export CASEDEV_LOG=info
+```
+
+Or to `debug` for more verbose logging.
+
+### How to tell whether `None` means `null` or missing
+
+In an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:
+
+```py
+if response.my_field is None:
+  if 'my_field' not in response.model_fields_set:
+    print('Got json like {}, without a "my_field" key present at all.')
+  else:
+    print('Got json like {"my_field": null}.')
+```
+
+### Accessing raw response data (e.g. headers)
+
+The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,
+
+```py
+from casedev import Casedev
+
+client = Casedev()
+response = client.vault.with_raw_response.create(
+    name="My Vault",
+)
+print(response.headers.get('X-My-Header'))
+
+vault = response.parse()  # get the object that `vault.create()` would have returned
+print(vault.id)
+```
+
+These methods return an [`APIResponse`](https://github.com/CaseMark/casedev-python/tree/main/src/casedev/_response.py) object.
+
+The async client returns an [`AsyncAPIResponse`](https://github.com/CaseMark/casedev-python/tree/main/src/casedev/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
+
+#### `.with_streaming_response`
+
+The above interface eagerly reads the full response body when you make the request, which may not always be what you want.
+
+To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
+
+```python
+with client.vault.with_streaming_response.create(
+    name="My Vault",
+) as response:
+    print(response.headers.get("X-My-Header"))
+
+    for line in response.iter_lines():
+        print(line)
+```
+
+The context manager is required so that the response will reliably be closed.
+
+### Making custom/undocumented requests
+
+This library is typed for convenient access to the documented API.
+
+If you need to access undocumented endpoints, params, or response properties, the library can still be used.
+
+#### Undocumented endpoints
+
+To make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other
+http verbs. Options on the client will be respected (such as retries) when making this request.
+
+```py
+import httpx
+
+response = client.post(
+    "/foo",
+    cast_to=httpx.Response,
+    body={"my_param": True},
+)
+
+print(response.headers.get("x-foo"))
+```
+
+#### Undocumented request params
+
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request
+options.
+
+#### Undocumented response properties
+
+To access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You
+can also get all the extra fields on the Pydantic model as a dict with
+[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).
+
+### Configuring the HTTP client
+
+You can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:
+
+- Support for [proxies](https://www.python-httpx.org/advanced/proxies/)
+- Custom [transports](https://www.python-httpx.org/advanced/transports/)
+- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality
+
+```python
+import httpx
+from casedev import Casedev, DefaultHttpxClient
+
+client = Casedev(
+    # Or use the `CASEDEV_BASE_URL` env var
+    base_url="http://my.test.server.example.com:8083",
+    http_client=DefaultHttpxClient(
+        proxy="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+You can also customize the client on a per-request basis by using `with_options()`:
+
+```python
+client.with_options(http_client=DefaultHttpxClient(...))
+```
+
+### Managing HTTP resources
+
+By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.
+
+```py
+from casedev import Casedev
+
+with Casedev() as client:
+  # make requests here
+  ...
+
+# HTTP client is now closed
+```
+
+## Versioning
+
+This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
+
+1. Changes that only affect static types, without breaking runtime behavior.
+2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_
+3. Changes that we do not expect to impact the vast majority of users in practice.
+
+We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
+
+We are keen for your feedback; please open an [issue](https://www.github.com/CaseMark/casedev-python/issues) with questions, bugs, or suggestions.
+
+### Determining the installed version
+
+If you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version.
+
+You can determine the version that is being used at runtime with:
+
+```py
+import casedev
+print(casedev.__version__)
+```
+
+## Requirements
+
+Python 3.9 or higher.
+
+## Contributing
+
+See [the contributing documentation](https://github.com/CaseMark/casedev-python/tree/main/./CONTRIBUTING.md).