deeprails 1.0.0__tar.gz → 1.3.0__tar.gz

deeprails-1.3.0/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "1.3.0"
+}

deeprails-1.3.0/CHANGELOG.md

@@ -0,0 +1,44 @@
+# Changelog
+
+## 1.3.0 (2025-10-08)
+
+Full Changelog: [v1.2.0...v1.3.0](https://github.com/deeprails/deeprails-sdk-python/compare/v1.2.0...v1.3.0)
+
+### Features
+
+* **api:** adding code samples ([c7f7565](https://github.com/deeprails/deeprails-sdk-python/commit/c7f7565abd00233d22d9c11a5b2c977414e03439))
+* **api:** manual updates ([145946a](https://github.com/deeprails/deeprails-sdk-python/commit/145946a049fb29bff01df6763248330f4d0030ad))
+
+## 1.2.0 (2025-10-07)
+
+Full Changelog: [v1.1.0...v1.2.0](https://github.com/deeprails/deeprails-sdk-python/compare/v1.1.0...v1.2.0)
+
+### Features
+
+* **api:** manual updates ([db3e710](https://github.com/deeprails/deeprails-sdk-python/commit/db3e710d267ccf8d99aa214348846e20b6484db6))
+
+## 1.1.0 (2025-10-07)
+
+Full Changelog: [v1.0.0...v1.1.0](https://github.com/deeprails/deeprails-sdk-python/compare/v1.0.0...v1.1.0)
+
+### Features
+
+* **api:** manual updates ([e55683b](https://github.com/deeprails/deeprails-sdk-python/commit/e55683b590ff636e7c876a172c22c52c3208ceda))
+* **api:** manual updates ([3309c85](https://github.com/deeprails/deeprails-sdk-python/commit/3309c859f9e67579bcd9d2f2d82ed7d67609dca8))
+
+
+### Chores
+
+* update SDK settings ([9b65ba6](https://github.com/deeprails/deeprails-sdk-python/commit/9b65ba6e8675011f89f035d608a404d7c1d50453))
+* update SDK settings ([957c361](https://github.com/deeprails/deeprails-sdk-python/commit/957c3611f3baf773270a491c66a28b8eeb66d671))
+* update SDK settings ([3dcb5cb](https://github.com/deeprails/deeprails-sdk-python/commit/3dcb5cb41ee6c1008f66dace32125fd38626bdca))
+* update SDK settings ([b283586](https://github.com/deeprails/deeprails-sdk-python/commit/b28358658ea8cbea0d2cb679343a9cf1c342fbd2))
+
+## 1.0.0 (2025-10-07)
+
+Full Changelog: [v0.0.1...v1.0.0](https://github.com/deeprails/deeprails-python-sdk/compare/v0.0.1...v1.0.0)
+
+### Chores
+
+* update SDK settings ([3dcb5cb](https://github.com/deeprails/deeprails-python-sdk/commit/3dcb5cb41ee6c1008f66dace32125fd38626bdca))
+* update SDK settings ([b283586](https://github.com/deeprails/deeprails-python-sdk/commit/b28358658ea8cbea0d2cb679343a9cf1c342fbd2))

{deeprails-1.0.0 → deeprails-1.3.0}/CONTRIBUTING.md

@@ -62,7 +62,7 @@ If you’d like to use the repository from source, you can either install from g
 To install via git:
 
 ```sh
-$ pip install git+ssh://git@github.com/deeprails/deeprails-python-sdk.git
+$ pip install git+ssh://git@github.com/deeprails/deeprails-sdk-python.git
 ```
 
 Alternatively, you can build from source and install the wheel file:
@@ -120,7 +120,7 @@ the changes aren't made through the automated pipeline, you may want to make rel
 
 ### Publish with a GitHub workflow
 
-You can release to package managers by using [the `Publish PyPI` GitHub action](https://www.github.com/deeprails/deeprails-python-sdk/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up.
+You can release to package managers by using [the `Publish PyPI` GitHub action](https://www.github.com/deeprails/deeprails-sdk-python/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up.
 
 ### Publish manually
 

{deeprails-1.0.0 → deeprails-1.3.0}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.3
 Name: deeprails
-Version: 1.0.0
+Version: 1.3.0
 Summary: The official Python library for the deeprails API
-Project-URL: Homepage, https://github.com/deeprails/deeprails-python-sdk
-Project-URL: Repository, https://github.com/deeprails/deeprails-python-sdk
-Author-email: Deeprails <support@deeprails.ai>
+Project-URL: Homepage, https://docs.deeprails.com/
+Project-URL: Repository, https://github.com/deeprails/deeprails-sdk-python
+Author-email: DeepRails <support@deeprails.ai>
 License: Apache-2.0
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
@@ -42,11 +42,9 @@ The Deeprails Python library provides convenient access to the Deeprails REST AP
 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 full API of this library can be found in [api.md](https://github.com/deeprails/deeprails-python-sdk/tree/main/api.md).
+The REST API documentation can be found on [docs.deeprails.com](https://docs.deeprails.com). The full API of this library can be found in [api.md](https://github.com/deeprails/deeprails-sdk-python/tree/main/api.md).
 
 ## Installation
 
@@ -57,7 +55,7 @@ pip install deeprails
 
 ## Usage
 
-The full API of this library can be found in [api.md](https://github.com/deeprails/deeprails-python-sdk/tree/main/api.md).
+The full API of this library can be found in [api.md](https://github.com/deeprails/deeprails-sdk-python/tree/main/api.md).
 
 ```python
 import os
@@ -65,26 +63,16 @@ from deeprails import Deeprails
 
 client = Deeprails(
     api_key=os.environ.get("DEEPRAILS_API_KEY"),  # This is the default and can be omitted
-    # defaults to "production".
-    environment="environment_1",
 )
 
 defend_response = client.defend.create_workflow(
-    improvement_action="regenerate",
+    improvement_action="fixit",
     metrics={
-        "0": 0,
-        "1": 0,
-        "2": 0,
-        "3": 0,
-        "4": 0,
-        "5": 0,
-        "6": 0,
-        "7": 0,
-        "8": 0,
-        "9": 0,
+        "completeness": 0.8,
+        "instruction_adherence": 0.75,
     },
-    name="REPLACE_ME",
-    type="automatic",
+    name="Push Alert Workflow",
+    type="custom",
 )
 print(defend_response.workflow_id)
 ```
@@ -105,28 +93,18 @@ from deeprails import AsyncDeeprails
 
 client = AsyncDeeprails(
     api_key=os.environ.get("DEEPRAILS_API_KEY"),  # This is the default and can be omitted
-    # defaults to "production".
-    environment="environment_1",
 )
 
 
 async def main() -> None:
     defend_response = await client.defend.create_workflow(
-        improvement_action="regenerate",
+        improvement_action="fixit",
         metrics={
-            "0": 0,
-            "1": 0,
-            "2": 0,
-            "3": 0,
-            "4": 0,
-            "5": 0,
-            "6": 0,
-            "7": 0,
-            "8": 0,
-            "9": 0,
+            "completeness": 0.8,
+            "instruction_adherence": 0.75,
         },
-        name="REPLACE_ME",
-        type="automatic",
+        name="Push Alert Workflow",
+        type="custom",
     )
     print(defend_response.workflow_id)
 
@@ -161,21 +139,13 @@ async def main() -> None:
         http_client=DefaultAioHttpClient(),
     ) as client:
         defend_response = await client.defend.create_workflow(
-            improvement_action="regenerate",
+            improvement_action="fixit",
             metrics={
-                "0": 0,
-                "1": 0,
-                "2": 0,
-                "3": 0,
-                "4": 0,
-                "5": 0,
-                "6": 0,
-                "7": 0,
-                "8": 0,
-                "9": 0,
+                "completeness": 0.8,
+                "instruction_adherence": 0.75,
             },
-            name="REPLACE_ME",
-            type="automatic",
+            name="Push Alert Workflow",
+            type="custom",
         )
         print(defend_response.workflow_id)
 
@@ -201,7 +171,7 @@ from deeprails import Deeprails
 
 client = Deeprails()
 
-workflow_event_response = client.defend.events.submit_event(
+workflow_event_response = client.defend.submit_event(
     workflow_id="workflow_id",
     model_input={"user_prompt": "user_prompt"},
     model_output="model_output",
@@ -229,21 +199,13 @@ client = Deeprails()
 
 try:
     client.defend.create_workflow(
-        improvement_action="regenerate",
+        improvement_action="fixit",
         metrics={
-            "0": 0,
-            "1": 0,
-            "2": 0,
-            "3": 0,
-            "4": 0,
-            "5": 0,
-            "6": 0,
-            "7": 0,
-            "8": 0,
-            "9": 0,
+            "completeness": 0.8,
+            "instruction_adherence": 0.75,
         },
-        name="REPLACE_ME",
-        type="automatic",
+        name="Push Alert Workflow",
+        type="custom",
     )
 except deeprails.APIConnectionError as e:
     print("The server could not be reached")
@@ -288,21 +250,13 @@ client = Deeprails(
 
 # Or, configure per-request:
 client.with_options(max_retries=5).defend.create_workflow(
-    improvement_action="regenerate",
+    improvement_action="fixit",
     metrics={
-        "0": 0,
-        "1": 0,
-        "2": 0,
-        "3": 0,
-        "4": 0,
-        "5": 0,
-        "6": 0,
-        "7": 0,
-        "8": 0,
-        "9": 0,
+        "completeness": 0.8,
+        "instruction_adherence": 0.75,
     },
-    name="REPLACE_ME",
-    type="automatic",
+    name="Push Alert Workflow",
+    type="custom",
 )
 ```
 
@@ -327,27 +281,19 @@ client = Deeprails(
 
 # Override per-request:
 client.with_options(timeout=5.0).defend.create_workflow(
-    improvement_action="regenerate",
+    improvement_action="fixit",
     metrics={
-        "0": 0,
-        "1": 0,
-        "2": 0,
-        "3": 0,
-        "4": 0,
-        "5": 0,
-        "6": 0,
-        "7": 0,
-        "8": 0,
-        "9": 0,
+        "completeness": 0.8,
+        "instruction_adherence": 0.75,
     },
-    name="REPLACE_ME",
-    type="automatic",
+    name="Push Alert Workflow",
+    type="custom",
 )
 ```
 
 On timeout, an `APITimeoutError` is thrown.
 
-Note that requests that time out are [retried twice by default](https://github.com/deeprails/deeprails-python-sdk/tree/main/#retries).
+Note that requests that time out are [retried twice by default](https://github.com/deeprails/deeprails-sdk-python/tree/main/#retries).
 
 ## Advanced
 
@@ -384,21 +330,13 @@ from deeprails import Deeprails
 
 client = Deeprails()
 response = client.defend.with_raw_response.create_workflow(
-    improvement_action="regenerate",
+    improvement_action="fixit",
     metrics={
-        "0": 0,
-        "1": 0,
-        "2": 0,
-        "3": 0,
-        "4": 0,
-        "5": 0,
-        "6": 0,
-        "7": 0,
-        "8": 0,
-        "9": 0,
+        "completeness": 0.8,
+        "instruction_adherence": 0.75,
     },
-    name="REPLACE_ME",
-    type="automatic",
+    name="Push Alert Workflow",
+    type="custom",
 )
 print(response.headers.get('X-My-Header'))
 
@@ -406,9 +344,9 @@ defend = response.parse()  # get the object that `defend.create_workflow()` woul
 print(defend.workflow_id)
 ```
 
-These methods return an [`APIResponse`](https://github.com/deeprails/deeprails-python-sdk/tree/main/src/deeprails/_response.py) object.
+These methods return an [`APIResponse`](https://github.com/deeprails/deeprails-sdk-python/tree/main/src/deeprails/_response.py) object.
 
-The async client returns an [`AsyncAPIResponse`](https://github.com/deeprails/deeprails-python-sdk/tree/main/src/deeprails/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
+The async client returns an [`AsyncAPIResponse`](https://github.com/deeprails/deeprails-sdk-python/tree/main/src/deeprails/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
 
 #### `.with_streaming_response`
 
@@ -418,21 +356,13 @@ To stream the response body, use `.with_streaming_response` instead, which requi
 
 ```python
 with client.defend.with_streaming_response.create_workflow(
-    improvement_action="regenerate",
+    improvement_action="fixit",
     metrics={
-        "0": 0,
-        "1": 0,
-        "2": 0,
-        "3": 0,
-        "4": 0,
-        "5": 0,
-        "6": 0,
-        "7": 0,
-        "8": 0,
-        "9": 0,
+        "completeness": 0.8,
+        "instruction_adherence": 0.75,
     },
-    name="REPLACE_ME",
-    type="automatic",
+    name="Push Alert Workflow",
+    type="custom",
 ) as response:
     print(response.headers.get("X-My-Header"))
 
@@ -442,109 +372,6 @@ with client.defend.with_streaming_response.create_workflow(
 
 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 deeprails import Deeprails, DefaultHttpxClient
-
-client = Deeprails(
-    # Or use the `DEEPRAILS_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 deeprails import Deeprails
-
-with Deeprails() 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/deeprails/deeprails-python-sdk/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 deeprails
-print(deeprails.__version__)
-```
-
 ## Requirements
 
 Python 3.8 or higher.
-
-## Contributing
-
-See [the contributing documentation](https://github.com/deeprails/deeprails-python-sdk/tree/main/./CONTRIBUTING.md).