schematichq 0.0.6__tar.gz

schematichq-0.0.6/PKG-INFO

@@ -0,0 +1,156 @@
+Metadata-Version: 2.1
+Name: schematichq
+Version: 0.0.6
+Summary: 
+Requires-Python: >=3.8,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: typing_extensions (>=4.0.0)
+Description-Content-Type: text/markdown
+
+# Schematic Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
+
+The Schematic Python Library provides convenient access to the Schematic API from 
+applications written in Python. 
+
+The library includes type definitions for all 
+request and response fields, and offers both synchronous and asynchronous clients powered by httpx.
+
+## Installation
+
+Add this dependency to your project's build file:
+
+```bash
+pip install schematichq
+# or
+poetry add schematichq
+```
+
+## Usage
+Simply import `Schematic` and start making calls to our API. 
+
+```python
+from schematic.client import Schematic
+
+client = Schematic(
+    api_key = "YOUR_API_KEY" # Defaults to SCHEMATIC_API_KEY
+)
+client.companies.get_company(
+    company_id="company_id",
+)
+```
+
+## Async Client
+The SDK also exports an async client so that you can make non-blocking
+calls to our API. 
+
+```python
+from schematic.client import AsyncSchematic
+
+client = AsyncSchematic(
+    api_key = "YOUR_API_KEY" # Defaults to SCHEMATIC_API_KEY
+)
+async def main() -> None:
+    await client.companies.get_company(
+        company_id="company_id",
+    )
+
+asyncio.run(main())
+```
+
+## Exception Handling
+All errors thrown by the SDK will be subclasses of [`ApiError`](./src/schematic/core/api_error.py).
+
+```python
+import schematic
+
+try:
+    client.companies.get_company(
+        company_id="company_id",
+    )
+except schematic.core.ApiError as e: # Handle all errors
+  print(e.status_code)
+  print(e.body)
+```
+
+## Advanced
+
+### Timeouts
+By default, requests time out after 60 seconds. You can configure this with a 
+timeout option at the client or request level.
+
+```python
+from schematic.client import Schematic
+
+client = Schematic(
+    # All timeouts are 20 seconds
+    timeout=20.0,
+)
+
+# Override timeout for a specific method
+client.companies.get_company(..., {
+    timeout_in_seconds=20.0
+})
+```
+
+### Retries
+The SDK is instrumented with automatic retries with exponential backoff. A request will be
+retried as long as the request is deemed retriable and the number of retry attempts has not grown larger
+than the configured retry limit (default: 2).
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+  
+Use the `max_retries` request option to configure this behavior. 
+
+```python
+# Override timeout for a specific method
+client.companies.get_company(..., {
+    max_retries=1 # Only retry once on failure
+})
+```
+
+### Custom HTTP client
+You can override the httpx client to customize it for your use-case. Some common use-cases 
+include support for proxies and transports.
+
+```python
+import httpx
+
+from schematic.client import Schematic
+
+client = Schematic(
+    http_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Beta Status
+
+This SDK is in **Preview**, and there may be breaking changes between versions without a major 
+version update. 
+
+To ensure a reproducible environment (and minimize risk of breaking changes), we recommend pinning a specific package version.
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically. 
+Additions made directly to this library would have to be moved over to our generation code, 
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+ a proof of concept, but know that we will not be able to merge it as-is. We suggest opening 
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!
+

schematichq-0.0.6/README.md

@@ -0,0 +1,140 @@
+# Schematic Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
+
+The Schematic Python Library provides convenient access to the Schematic API from 
+applications written in Python. 
+
+The library includes type definitions for all 
+request and response fields, and offers both synchronous and asynchronous clients powered by httpx.
+
+## Installation
+
+Add this dependency to your project's build file:
+
+```bash
+pip install schematichq
+# or
+poetry add schematichq
+```
+
+## Usage
+Simply import `Schematic` and start making calls to our API. 
+
+```python
+from schematic.client import Schematic
+
+client = Schematic(
+    api_key = "YOUR_API_KEY" # Defaults to SCHEMATIC_API_KEY
+)
+client.companies.get_company(
+    company_id="company_id",
+)
+```
+
+## Async Client
+The SDK also exports an async client so that you can make non-blocking
+calls to our API. 
+
+```python
+from schematic.client import AsyncSchematic
+
+client = AsyncSchematic(
+    api_key = "YOUR_API_KEY" # Defaults to SCHEMATIC_API_KEY
+)
+async def main() -> None:
+    await client.companies.get_company(
+        company_id="company_id",
+    )
+
+asyncio.run(main())
+```
+
+## Exception Handling
+All errors thrown by the SDK will be subclasses of [`ApiError`](./src/schematic/core/api_error.py).
+
+```python
+import schematic
+
+try:
+    client.companies.get_company(
+        company_id="company_id",
+    )
+except schematic.core.ApiError as e: # Handle all errors
+  print(e.status_code)
+  print(e.body)
+```
+
+## Advanced
+
+### Timeouts
+By default, requests time out after 60 seconds. You can configure this with a 
+timeout option at the client or request level.
+
+```python
+from schematic.client import Schematic
+
+client = Schematic(
+    # All timeouts are 20 seconds
+    timeout=20.0,
+)
+
+# Override timeout for a specific method
+client.companies.get_company(..., {
+    timeout_in_seconds=20.0
+})
+```
+
+### Retries
+The SDK is instrumented with automatic retries with exponential backoff. A request will be
+retried as long as the request is deemed retriable and the number of retry attempts has not grown larger
+than the configured retry limit (default: 2).
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+  
+Use the `max_retries` request option to configure this behavior. 
+
+```python
+# Override timeout for a specific method
+client.companies.get_company(..., {
+    max_retries=1 # Only retry once on failure
+})
+```
+
+### Custom HTTP client
+You can override the httpx client to customize it for your use-case. Some common use-cases 
+include support for proxies and transports.
+
+```python
+import httpx
+
+from schematic.client import Schematic
+
+client = Schematic(
+    http_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Beta Status
+
+This SDK is in **Preview**, and there may be breaking changes between versions without a major 
+version update. 
+
+To ensure a reproducible environment (and minimize risk of breaking changes), we recommend pinning a specific package version.
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically. 
+Additions made directly to this library would have to be moved over to our generation code, 
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+ a proof of concept, but know that we will not be able to merge it as-is. We suggest opening 
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

schematichq-0.0.6/pyproject.toml

@@ -0,0 +1,33 @@
+[tool.poetry]
+name = "schematichq"
+version = "0.0.6"
+description = ""
+readme = "README.md"
+authors = []
+packages = [
+    { include = "schematic", from = "src"}
+]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+httpx = ">=0.21.2"
+pydantic = ">= 1.9.2"
+typing_extensions = ">= 4.0.0"
+
+[tool.poetry.dev-dependencies]
+mypy = "1.9.0"
+pytest = "^7.4.0"
+pytest-asyncio = "^0.23.5"
+python-dateutil = "^2.9.0"
+
+[tool.pytest.ini_options]
+testpaths = [ "tests" ]
+asyncio_mode = "auto"
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"