Merge pull request #98 from writer/release-please--branches--main--changes--next

release: 1.3.0

Author: ramedina86

.release-please-manifest.json

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

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 18
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/writerai%2Fwriter-4206be8170d98e1f909e4c0e34167f63952645f292b0e4fa7459ca7fcfc1b48a.yml
+configured_endpoints: 21
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/writerai%2Fwriter-82683f2fd5f8778a27960ebabda40d6dc4640bdfb77ac4ec7f173b8bf8076d3c.yml

CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## 1.3.0 (2024-11-12)
+
+Full Changelog: [v1.2.0...v1.3.0](https://github.com/writer/writer-python/compare/v1.2.0...v1.3.0)
+
+### Features
+
+* **api:** add streaming to kg question ([#109](https://github.com/writer/writer-python/issues/109)) ([cf85c8a](https://github.com/writer/writer-python/commit/cf85c8a2f569481605d16302a7ff785ae0225b9b))
+* **api:** api update ([#108](https://github.com/writer/writer-python/issues/108)) ([785dd02](https://github.com/writer/writer-python/commit/785dd02659bd11b983bf98fc4c10923ce5dcc2a4))
+* **api:** api update ([#97](https://github.com/writer/writer-python/issues/97)) ([75f6211](https://github.com/writer/writer-python/commit/75f6211064189a457b520c9dd7c7d7f9edd7d58f))
+* **api:** manual updates ([#102](https://github.com/writer/writer-python/issues/102)) ([25d0319](https://github.com/writer/writer-python/commit/25d031937bab3307b96cee0682967ddbe38f78b9))
+* **api:** manual updates ([#111](https://github.com/writer/writer-python/issues/111)) ([9f80bb4](https://github.com/writer/writer-python/commit/9f80bb43bf56789f53cec048102cc45611a734eb))
+* **api:** manual updates ([#114](https://github.com/writer/writer-python/issues/114)) ([b9fc454](https://github.com/writer/writer-python/commit/b9fc45415b8bda5d2e0c1f8bbf2e3e064904a0b3))
+* **api:** rename kg question and add text-to-graph ([#112](https://github.com/writer/writer-python/issues/112)) ([c4ac9fd](https://github.com/writer/writer-python/commit/c4ac9fd60b3d71162b179812278f6801500778c3))
+* **api:** update tools api methods ([#107](https://github.com/writer/writer-python/issues/107)) ([c45ab5b](https://github.com/writer/writer-python/commit/c45ab5b4e9012cfb7118d32507b836a61fb192d6))
+
+
+### Bug Fixes
+
+* fix tool_choice schema ([403c875](https://github.com/writer/writer-python/commit/403c8755937a9c2744d0f0f214ab48fd2253180b))
+
+
+### Chores
+
+* rebuild project due to codegen change ([#100](https://github.com/writer/writer-python/issues/100)) ([fbb3664](https://github.com/writer/writer-python/commit/fbb3664b0988352f139a30fe2d10f184f4f552a6))
+* rebuild project due to codegen change ([#101](https://github.com/writer/writer-python/issues/101)) ([1e0cbc1](https://github.com/writer/writer-python/commit/1e0cbc156a7f51a498f73acf006701d962ba8260))
+* rebuild project due to codegen change ([#103](https://github.com/writer/writer-python/issues/103)) ([dcd2402](https://github.com/writer/writer-python/commit/dcd24028b99180a638efee77a69ed2edf43d0d1c))
+* rebuild project due to codegen change ([#104](https://github.com/writer/writer-python/issues/104)) ([e9f2e66](https://github.com/writer/writer-python/commit/e9f2e66fbf9701c2c60f71f416cc2fd91182a3df))
+* rebuild project due to codegen change ([#105](https://github.com/writer/writer-python/issues/105)) ([4d1c32c](https://github.com/writer/writer-python/commit/4d1c32cbe04e030d1756be2927da0a036ffe6af7))
+* rebuild project due to codegen change ([#106](https://github.com/writer/writer-python/issues/106)) ([5c27b9e](https://github.com/writer/writer-python/commit/5c27b9e56736feb09c6c03790bdb0678494cff3f))
+* rebuild project due to codegen change ([#113](https://github.com/writer/writer-python/issues/113)) ([477b79c](https://github.com/writer/writer-python/commit/477b79c4e0ab5edd3b4593557a01313b19148f04))
+* rebuild project due to codegen change ([#99](https://github.com/writer/writer-python/issues/99)) ([490c02f](https://github.com/writer/writer-python/commit/490c02f05254023c7636cef86b6d234a81ee3d94))
+
 ## 1.2.0 (2024-10-10)
 
 Full Changelog: [v1.1.0...v1.2.0](https://github.com/writer/writer-python/compare/v1.1.0...v1.2.0)

README.md

@@ -2,7 +2,7 @@
 
 [![PyPI version](https://img.shields.io/pypi/v/writer-sdk.svg)](https://pypi.org/project/writer-sdk/)
 
-The Writer Python library provides convenient access to the Writer REST API from any Python 3.7+
+The Writer Python library provides convenient access to the Writer REST API from any Python 3.8+
 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).
 
@@ -29,8 +29,7 @@ import os
 from writerai import Writer
 
 client = Writer(
-    # This is the default and can be omitted
-    api_key=os.environ.get("WRITER_API_KEY"),
+    api_key=os.environ.get("WRITER_API_KEY"),  # This is the default and can be omitted
 )
 
 chat = client.chat.chat(
@@ -55,8 +54,7 @@ import asyncio
 from writerai import AsyncWriter
 
 client = AsyncWriter(
-    # This is the default and can be omitted
-    api_key=os.environ.get("WRITER_API_KEY"),
+    api_key=os.environ.get("WRITER_API_KEY"),  # This is the default and can be omitted
 )
 
 
@@ -436,7 +434,7 @@ print(writerai.__version__)
 
 ## Requirements
 
-Python 3.7 or higher.
+Python 3.8 or higher.
 
 ## Contributing
 

api.md

@@ -54,6 +54,7 @@ Types:
 from writerai.types import (
     Graph,
     Question,
+    QuestionResponseChunk,
     GraphCreateResponse,
     GraphUpdateResponse,
     GraphDeleteResponse,
@@ -88,3 +89,28 @@ Methods:
 - <code title="get /v1/files/{file_id}/download">client.files.<a href="./src/writerai/resources/files.py">download</a>(file_id) -> BinaryAPIResponse</code>
 - <code title="post /v1/files/retry">client.files.<a href="./src/writerai/resources/files.py">retry</a>(\*\*<a href="src/writerai/types/file_retry_params.py">params</a>) -> <a href="./src/writerai/types/file_retry_response.py">FileRetryResponse</a></code>
 - <code title="post /v1/files">client.files.<a href="./src/writerai/resources/files.py">upload</a>(\*\*<a href="src/writerai/types/file_upload_params.py">params</a>) -> <a href="./src/writerai/types/file.py">File</a></code>
+
+# Tools
+
+Types:
+
+```python
+from writerai.types import ToolContextAwareSplittingResponse, ToolParsePdfResponse
+```
+
+Methods:
+
+- <code title="post /v1/tools/context-aware-splitting">client.tools.<a href="./src/writerai/resources/tools/tools.py">context_aware_splitting</a>(\*\*<a href="src/writerai/types/tool_context_aware_splitting_params.py">params</a>) -> <a href="./src/writerai/types/tool_context_aware_splitting_response.py">ToolContextAwareSplittingResponse</a></code>
+- <code title="post /v1/tools/pdf-parser/{file_id}">client.tools.<a href="./src/writerai/resources/tools/tools.py">parse_pdf</a>(file_id, \*\*<a href="src/writerai/types/tool_parse_pdf_params.py">params</a>) -> <a href="./src/writerai/types/tool_parse_pdf_response.py">ToolParsePdfResponse</a></code>
+
+## Comprehend
+
+Types:
+
+```python
+from writerai.types.tools import ComprehendMedicalResponse
+```
+
+Methods:
+
+- <code title="post /v1/tools/comprehend/medical">client.tools.comprehend.<a href="./src/writerai/resources/tools/comprehend.py">medical</a>(\*\*<a href="src/writerai/types/tools/comprehend_medical_params.py">params</a>) -> <a href="./src/writerai/types/tools/comprehend_medical_response.py">ComprehendMedicalResponse</a></code>

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "writer-sdk"
-version = "1.2.0"
+version = "1.3.0"
 description = "The official Python library for the writer API"
 dynamic = ["readme"]
 license = "Apache-2.0"
@@ -16,11 +16,10 @@ dependencies = [
     "sniffio",
     "cached-property; python_version < '3.8'",
 ]
-requires-python = ">= 3.7"
+requires-python = ">= 3.8"
 classifiers = [
   "Typing :: Typed",
   "Intended Audience :: Developers",
-  "Programming Language :: Python :: 3.7",
   "Programming Language :: Python :: 3.8",
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
@@ -63,11 +62,11 @@ format = { chain = [
   "format:ruff",
   "format:docs",
   "fix:ruff",
+  # run formatting again to fix any inconsistencies when imports are stripped
+  "format:ruff",
 ]}
-"format:black" = "black ."
 "format:docs" = "python scripts/utils/ruffen-docs.py README.md api.md"
 "format:ruff" = "ruff format"
-"format:isort" = "isort ."
 
 "lint" = { chain = [
   "check:ruff",
@@ -125,10 +124,6 @@ path = "README.md"
 pattern = '\[(.+?)\]\(((?!https?://)\S+?)\)'
 replacement = '[\1](https://github.com/writer/writer-python/tree/main/\g<2>)'
 
-[tool.black]
-line-length = 120
-target-version = ["py37"]
-
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 addopts = "--tb=short"
@@ -143,7 +138,7 @@ filterwarnings = [
 # there are a couple of flags that are still disabled by
 # default in strict mode as they are experimental and niche.
 typeCheckingMode = "strict"
-pythonVersion = "3.7"
+pythonVersion = "3.8"
 
 exclude = [
     "_dev",

requirements-dev.lock

@@ -17,8 +17,6 @@ anyio==4.4.0
     # via writer-sdk
 argcomplete==3.1.2
     # via nox
-attrs==23.1.0
-    # via pytest
 certifi==2023.7.22
     # via httpcore
     # via httpx
@@ -29,8 +27,9 @@ distlib==0.3.7
     # via virtualenv
 distro==1.8.0
     # via writer-sdk
-exceptiongroup==1.1.3
+exceptiongroup==1.2.2
     # via anyio
+    # via pytest
 filelock==3.12.4
     # via virtualenv
 h11==0.14.0
@@ -50,7 +49,7 @@ markdown-it-py==3.0.0
     # via rich
 mdurl==0.1.2
     # via markdown-it-py
-mypy==1.11.2
+mypy==1.13.0
 mypy-extensions==1.0.0
     # via mypy
 nodeenv==1.8.0
@@ -61,27 +60,25 @@ packaging==23.2
     # via pytest
 platformdirs==3.11.0
     # via virtualenv
-pluggy==1.3.0
-    # via pytest
-py==1.11.0
+pluggy==1.5.0
     # via pytest
-pydantic==2.7.1
+pydantic==2.9.2
     # via writer-sdk
-pydantic-core==2.18.2
+pydantic-core==2.23.4
     # via pydantic
 pygments==2.18.0
     # via rich
 pyright==1.1.380
-pytest==7.1.1
+pytest==8.3.3
     # via pytest-asyncio
-pytest-asyncio==0.21.1
+pytest-asyncio==0.24.0
 python-dateutil==2.8.2
     # via time-machine
 pytz==2023.3.post1
     # via dirty-equals
 respx==0.20.2
 rich==13.7.1
-ruff==0.6.5
+ruff==0.6.9
 setuptools==68.2.2
     # via nodeenv
 six==1.16.0
@@ -91,10 +88,10 @@ sniffio==1.3.0
     # via httpx
     # via writer-sdk
 time-machine==2.9.0
-tomli==2.0.1
+tomli==2.0.2
     # via mypy
     # via pytest
-typing-extensions==4.8.0
+typing-extensions==4.12.2
     # via anyio
     # via mypy
     # via pydantic

requirements.lock

@@ -20,7 +20,7 @@ certifi==2023.7.22
     # via httpx
 distro==1.8.0
     # via writer-sdk
-exceptiongroup==1.1.3
+exceptiongroup==1.2.2
     # via anyio
 h11==0.14.0
     # via httpcore
@@ -31,15 +31,15 @@ httpx==0.25.2
 idna==3.4
     # via anyio
     # via httpx
-pydantic==2.7.1
+pydantic==2.9.2
     # via writer-sdk
-pydantic-core==2.18.2
+pydantic-core==2.23.4
     # via pydantic
 sniffio==1.3.0
     # via anyio
     # via httpx
     # via writer-sdk
-typing-extensions==4.8.0
+typing-extensions==4.12.2
     # via anyio
     # via pydantic
     # via pydantic-core

src/writerai/_base_client.py

@@ -1587,7 +1587,7 @@ async def _request(
         except Exception as err:
             log.debug("Encountered Exception", exc_info=True)
 
-            if retries_taken > 0:
+            if remaining_retries > 0:
                 return await self._retry_request(
                     input_options,
                     cast_to,

src/writerai/_client.py

@@ -52,6 +52,7 @@ class Writer(SyncAPIClient):
     models: resources.ModelsResource
     graphs: resources.GraphsResource
     files: resources.FilesResource
+    tools: resources.ToolsResource
     with_raw_response: WriterWithRawResponse
     with_streaming_response: WriterWithStreamedResponse
 
@@ -117,6 +118,7 @@ def __init__(
         self.models = resources.ModelsResource(self)
         self.graphs = resources.GraphsResource(self)
         self.files = resources.FilesResource(self)
+        self.tools = resources.ToolsResource(self)
         self.with_raw_response = WriterWithRawResponse(self)
         self.with_streaming_response = WriterWithStreamedResponse(self)
 
@@ -232,6 +234,7 @@ class AsyncWriter(AsyncAPIClient):
     models: resources.AsyncModelsResource
     graphs: resources.AsyncGraphsResource
     files: resources.AsyncFilesResource
+    tools: resources.AsyncToolsResource
     with_raw_response: AsyncWriterWithRawResponse
     with_streaming_response: AsyncWriterWithStreamedResponse
 
@@ -297,6 +300,7 @@ def __init__(
         self.models = resources.AsyncModelsResource(self)
         self.graphs = resources.AsyncGraphsResource(self)
         self.files = resources.AsyncFilesResource(self)
+        self.tools = resources.AsyncToolsResource(self)
         self.with_raw_response = AsyncWriterWithRawResponse(self)
         self.with_streaming_response = AsyncWriterWithStreamedResponse(self)
 
@@ -413,6 +417,7 @@ def __init__(self, client: Writer) -> None:
         self.models = resources.ModelsResourceWithRawResponse(client.models)
         self.graphs = resources.GraphsResourceWithRawResponse(client.graphs)
         self.files = resources.FilesResourceWithRawResponse(client.files)
+        self.tools = resources.ToolsResourceWithRawResponse(client.tools)
 
 
 class AsyncWriterWithRawResponse:
@@ -423,6 +428,7 @@ def __init__(self, client: AsyncWriter) -> None:
         self.models = resources.AsyncModelsResourceWithRawResponse(client.models)
         self.graphs = resources.AsyncGraphsResourceWithRawResponse(client.graphs)
         self.files = resources.AsyncFilesResourceWithRawResponse(client.files)
+        self.tools = resources.AsyncToolsResourceWithRawResponse(client.tools)
 
 
 class WriterWithStreamedResponse:
@@ -433,6 +439,7 @@ def __init__(self, client: Writer) -> None:
         self.models = resources.ModelsResourceWithStreamingResponse(client.models)
         self.graphs = resources.GraphsResourceWithStreamingResponse(client.graphs)
         self.files = resources.FilesResourceWithStreamingResponse(client.files)
+        self.tools = resources.ToolsResourceWithStreamingResponse(client.tools)
 
 
 class AsyncWriterWithStreamedResponse:
@@ -443,6 +450,7 @@ def __init__(self, client: AsyncWriter) -> None:
         self.models = resources.AsyncModelsResourceWithStreamingResponse(client.models)
         self.graphs = resources.AsyncGraphsResourceWithStreamingResponse(client.graphs)
         self.files = resources.AsyncFilesResourceWithStreamingResponse(client.files)
+        self.tools = resources.AsyncToolsResourceWithStreamingResponse(client.tools)
 
 
 Client = Writer