Skip to content

Commit 4f42203

Browse files
committed
Release 0.1.3
1 parent 96333b1 commit 4f42203

File tree

3 files changed

+151
-3
lines changed

3 files changed

+151
-3
lines changed

README.md

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
# Devintest Python Library
2+
3+
[![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%2Fdevalog%2Fpython-sdk)
4+
[![pypi](https://img.shields.io/pypi/v/devin-new-test-package)](https://pypi.python.org/pypi/devin-new-test-package)
5+
6+
Welcome to my API
7+
8+
## Installation
9+
10+
```sh
11+
pip install devin-new-test-package
12+
```
13+
14+
## Reference
15+
16+
A full reference for this library is available [here](https://github.com/devalog/python-sdk/blob/HEAD/./reference.md).
17+
18+
## Usage
19+
20+
Instantiate and use the client with the following:
21+
22+
```python
23+
from devintest import MyClientNameDevin
24+
25+
client = MyClientNameDevin(
26+
base_url="https://yourhost.com/path/to/api",
27+
)
28+
client.imdb.create_movie(
29+
title="title",
30+
rating=1.1,
31+
)
32+
```
33+
34+
## Async Client
35+
36+
The SDK also exports an `async` client so that you can make non-blocking calls to our API.
37+
38+
```python
39+
import asyncio
40+
41+
from devintest import AsyncMyClientNameDevin
42+
43+
client = AsyncMyClientNameDevin(
44+
base_url="https://yourhost.com/path/to/api",
45+
)
46+
47+
48+
async def main() -> None:
49+
await client.imdb.create_movie(
50+
title="title",
51+
rating=1.1,
52+
)
53+
54+
55+
asyncio.run(main())
56+
```
57+
58+
## Exception Handling
59+
60+
When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
61+
will be thrown.
62+
63+
```python
64+
from devintest.core.api_error import ApiError
65+
66+
try:
67+
client.imdb.create_movie(...)
68+
except ApiError as e:
69+
print(e.status_code)
70+
print(e.body)
71+
```
72+
73+
## Advanced
74+
75+
### Access Raw Response Data
76+
77+
The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
78+
The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
79+
80+
```python
81+
from devintest import MyClientNameDevin
82+
83+
client = MyClientNameDevin(
84+
...,
85+
)
86+
response = client.imdb.with_raw_response.create_movie(...)
87+
print(response.headers) # access the response headers
88+
print(response.data) # access the underlying object
89+
```
90+
91+
### Retries
92+
93+
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
94+
as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
95+
retry limit (default: 2).
96+
97+
A request is deemed retryable when any of the following HTTP status codes is returned:
98+
99+
- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
100+
- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
101+
- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
102+
103+
Use the `max_retries` request option to configure this behavior.
104+
105+
```python
106+
client.imdb.create_movie(..., request_options={
107+
"max_retries": 1
108+
})
109+
```
110+
111+
### Timeouts
112+
113+
The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
114+
115+
```python
116+
117+
from devintest import MyClientNameDevin
118+
119+
client = MyClientNameDevin(
120+
...,
121+
timeout=20.0,
122+
)
123+
124+
125+
# Override timeout for a specific method
126+
client.imdb.create_movie(..., request_options={
127+
"timeout_in_seconds": 1
128+
})
129+
```
130+
131+
### Custom Client
132+
133+
You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
134+
and transports.
135+
136+
```python
137+
import httpx
138+
from devintest import MyClientNameDevin
139+
140+
client = MyClientNameDevin(
141+
...,
142+
httpx_client=httpx.Client(
143+
proxies="http://my.test.proxy.example.com",
144+
transport=httpx.HTTPTransport(local_address="0.0.0.0"),
145+
),
146+
)
147+
```
148+

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name = "devin-new-test-package"
33

44
[tool.poetry]
55
name = "devin-new-test-package"
6-
version = "0.1.2"
6+
version = "0.1.3"
77
description = ""
88
readme = "README.md"
99
authors = []

src/devintest/core/client_wrapper.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,10 @@ def __init__(
2020

2121
def get_headers(self) -> typing.Dict[str, str]:
2222
headers: typing.Dict[str, str] = {
23-
"User-Agent": "devin-new-test-package/0.1.2",
23+
"User-Agent": "devin-new-test-package/0.1.3",
2424
"X-Fern-Language": "Python",
2525
"X-Fern-SDK-Name": "devin-new-test-package",
26-
"X-Fern-SDK-Version": "0.1.2",
26+
"X-Fern-SDK-Version": "0.1.3",
2727
**(self.get_custom_headers() or {}),
2828
}
2929
return headers

0 commit comments

Comments
 (0)