Skip to content

Commit 7d40c09

Browse files
committed
Release 0.0.13
1 parent 5b5525c commit 7d40c09

File tree

11 files changed

+404
-115
lines changed

11 files changed

+404
-115
lines changed

README.md

Lines changed: 27 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,22 @@ A full reference for this library is available [here](./reference.md).
2020
Instantiate and use the client with the following:
2121

2222
```python
23-
from axiomatic import Axiomatic
23+
from axiomatic import Axiomatic, RequirementBody
2424

2525
client = Axiomatic(
2626
api_key="YOUR_API_KEY",
2727
)
28-
client.pic.extract()
28+
client.requirements.check_requirements_endpoint(
29+
request=[
30+
RequirementBody(
31+
latex_symbol="latex_symbol",
32+
requirement_name="requirement_name",
33+
tolerance=1.1,
34+
value=1.1,
35+
units="units",
36+
)
37+
],
38+
)
2939
```
3040

3141
## Async Client
@@ -35,15 +45,25 @@ The SDK also exports an `async` client so that you can make non-blocking calls t
3545
```python
3646
import asyncio
3747

38-
from axiomatic import AsyncAxiomatic
48+
from axiomatic import AsyncAxiomatic, RequirementBody
3949

4050
client = AsyncAxiomatic(
4151
api_key="YOUR_API_KEY",
4252
)
4353

4454

4555
async def main() -> None:
46-
await client.pic.extract()
56+
await client.requirements.check_requirements_endpoint(
57+
request=[
58+
RequirementBody(
59+
latex_symbol="latex_symbol",
60+
requirement_name="requirement_name",
61+
tolerance=1.1,
62+
value=1.1,
63+
units="units",
64+
)
65+
],
66+
)
4767

4868

4969
asyncio.run(main())
@@ -58,7 +78,7 @@ will be thrown.
5878
from axiomatic.core.api_error import ApiError
5979

6080
try:
61-
client.pic.extract(...)
81+
client.requirements.check_requirements_endpoint(...)
6282
except ApiError as e:
6383
print(e.status_code)
6484
print(e.body)
@@ -81,7 +101,7 @@ A request is deemed retriable when any of the following HTTP status codes is ret
81101
Use the `max_retries` request option to configure this behavior.
82102

83103
```python
84-
client.pic.extract(..., request_options={
104+
client.requirements.check_requirements_endpoint(..., request_options={
85105
"max_retries": 1
86106
})
87107
```
@@ -101,7 +121,7 @@ client = Axiomatic(
101121

102122

103123
# Override timeout for a specific method
104-
client.pic.extract(..., request_options={
124+
client.requirements.check_requirements_endpoint(..., request_options={
105125
"timeout_in_seconds": 1
106126
})
107127
```

poetry.lock

Lines changed: 105 additions & 105 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[tool.poetry]
22
name = "axiomatic"
3-
version = "0.0.12"
3+
version = "0.0.13"
44
description = ""
55
readme = "README.md"
66
authors = []

reference.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,71 @@ client.health_check_health_check_get()
4141
</dl>
4242

4343

44+
</dd>
45+
</dl>
46+
</details>
47+
48+
## requirements
49+
<details><summary><code>client.requirements.<a href="src/axiomatic/requirements/client.py">check_requirements_endpoint</a>(...)</code></summary>
50+
<dl>
51+
<dd>
52+
53+
#### 🔌 Usage
54+
55+
<dl>
56+
<dd>
57+
58+
<dl>
59+
<dd>
60+
61+
```python
62+
from axiomatic import Axiomatic, RequirementBody
63+
64+
client = Axiomatic(
65+
api_key="YOUR_API_KEY",
66+
)
67+
client.requirements.check_requirements_endpoint(
68+
request=[
69+
RequirementBody(
70+
latex_symbol="latex_symbol",
71+
requirement_name="requirement_name",
72+
tolerance=1.1,
73+
value=1.1,
74+
units="units",
75+
)
76+
],
77+
)
78+
79+
```
80+
</dd>
81+
</dl>
82+
</dd>
83+
</dl>
84+
85+
#### ⚙️ Parameters
86+
87+
<dl>
88+
<dd>
89+
90+
<dl>
91+
<dd>
92+
93+
**request:** `typing.Sequence[RequirementBody]`
94+
95+
</dd>
96+
</dl>
97+
98+
<dl>
99+
<dd>
100+
101+
**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
102+
103+
</dd>
104+
</dl>
105+
</dd>
106+
</dl>
107+
108+
44109
</dd>
45110
</dl>
46111
</details>

src/axiomatic/__init__.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
PicComponentInfoValue,
1919
PicComponentSettingsValue,
2020
RefineCodeResponse,
21+
RequirementBody,
2122
Statement,
2223
StatementInput,
2324
SynthesisResponse,
@@ -29,7 +30,7 @@
2930
VerifyNetlistResponse,
3031
)
3132
from .errors import UnprocessableEntityError
32-
from . import experimental, formalization, generic, lean, pic
33+
from . import experimental, formalization, generic, lean, pic, requirements
3334
from .client import AsyncAxiomatic, Axiomatic
3435
from .environment import AxiomaticEnvironment
3536
from .version import __version__
@@ -55,6 +56,7 @@
5556
"PicComponentInfoValue",
5657
"PicComponentSettingsValue",
5758
"RefineCodeResponse",
59+
"RequirementBody",
5860
"Statement",
5961
"StatementInput",
6062
"SynthesisResponse",
@@ -71,4 +73,5 @@
7173
"generic",
7274
"lean",
7375
"pic",
76+
"requirements",
7477
]

src/axiomatic/client.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
from .environment import AxiomaticEnvironment
55
import httpx
66
from .core.client_wrapper import SyncClientWrapper
7+
from .requirements.client import RequirementsClient
78
from .pic.client import PicClient
89
from .lean.client import LeanClient
910
from .experimental.client import ExperimentalClient
@@ -14,6 +15,7 @@
1415
from json.decoder import JSONDecodeError
1516
from .core.api_error import ApiError
1617
from .core.client_wrapper import AsyncClientWrapper
18+
from .requirements.client import AsyncRequirementsClient
1719
from .pic.client import AsyncPicClient
1820
from .lean.client import AsyncLeanClient
1921
from .experimental.client import AsyncExperimentalClient
@@ -79,6 +81,7 @@ def __init__(
7981
else httpx.Client(timeout=_defaulted_timeout),
8082
timeout=_defaulted_timeout,
8183
)
84+
self.requirements = RequirementsClient(client_wrapper=self._client_wrapper)
8285
self.pic = PicClient(client_wrapper=self._client_wrapper)
8386
self.lean = LeanClient(client_wrapper=self._client_wrapper)
8487
self.experimental = ExperimentalClient(client_wrapper=self._client_wrapper)
@@ -186,6 +189,7 @@ def __init__(
186189
else httpx.AsyncClient(timeout=_defaulted_timeout),
187190
timeout=_defaulted_timeout,
188191
)
192+
self.requirements = AsyncRequirementsClient(client_wrapper=self._client_wrapper)
189193
self.pic = AsyncPicClient(client_wrapper=self._client_wrapper)
190194
self.lean = AsyncLeanClient(client_wrapper=self._client_wrapper)
191195
self.experimental = AsyncExperimentalClient(client_wrapper=self._client_wrapper)

src/axiomatic/core/client_wrapper.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ def get_headers(self) -> typing.Dict[str, str]:
1616
headers: typing.Dict[str, str] = {
1717
"X-Fern-Language": "Python",
1818
"X-Fern-SDK-Name": "axiomatic",
19-
"X-Fern-SDK-Version": "0.0.12",
19+
"X-Fern-SDK-Version": "0.0.13",
2020
}
2121
headers["x-api-key"] = self.api_key
2222
return headers
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# This file was auto-generated by Fern from our API Definition.
2+

0 commit comments

Comments
 (0)