pulse-python-sdk 0.0.52__py3-none-any.whl

pulse_python_sdk-0.0.52.dist-info/METADATA

@@ -0,0 +1,197 @@
+Metadata-Version: 2.1
+Name: pulse-python-sdk
+Version: 0.0.52
+Summary: 
+Requires-Python: >=3.8,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+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
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: pydantic-core (>=2.18.2)
+Requires-Dist: typing_extensions (>=4.0.0)
+Project-URL: Repository, https://github.com/Pulse-Software-Corp/pulse-python-sdk
+Description-Content-Type: text/markdown
+
+# Pulse Python Library
+
+[![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%2FPulse-Software-Corp%2Fpulse-python-sdk)
+[![pypi](https://img.shields.io/pypi/v/pulse-python-sdk)](https://pypi.python.org/pypi/pulse-python-sdk)
+
+The Pulse Python library provides convenient access to the Pulse APIs from Python.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Reference](#reference)
+- [Usage](#usage)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Access Raw Response Data](#access-raw-response-data)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
+## Installation
+
+```sh
+pip install pulse-python-sdk
+```
+
+## Reference
+
+A full reference for this library is available [here](https://github.com/Pulse-Software-Corp/pulse-python-sdk/blob/HEAD/./reference.md).
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from pulse import Pulse
+
+client = Pulse(
+    api_key="YOUR_API_KEY",
+)
+client.extract(
+    file_url="fileUrl",
+)
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API. Note that if you are constructing an Async httpx client class to pass into this client, use `httpx.AsyncClient()` instead of `httpx.Client()` (e.g. for the `httpx_client` parameter of this client).
+
+```python
+import asyncio
+
+from pulse import AsyncPulse
+
+client = AsyncPulse(
+    api_key="YOUR_API_KEY",
+)
+
+
+async def main() -> None:
+    await client.extract(
+        file_url="fileUrl",
+    )
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from pulse.core.api_error import ApiError
+
+try:
+    client.extract(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Access Raw Response Data
+
+The SDK provides access to raw response data, including headers, through the `.with_raw_response` property.
+The `.with_raw_response` property returns a "raw" client that can be used to access the `.headers` and `.data` attributes.
+
+```python
+from pulse import Pulse
+
+client = Pulse(
+    ...,
+)
+response = client.with_raw_response.extract(...)
+print(response.headers)  # access the response headers
+print(response.data)  # access the underlying object
+```
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retryable 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
+client.extract(..., request_options={
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+
+from pulse import Pulse
+
+client = Pulse(
+    ...,
+    timeout=20.0,
+)
+
+
+# Override timeout for a specific method
+client.extract(..., request_options={
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom 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 pulse import Pulse
+
+client = Pulse(
+    ...,
+    httpx_client=httpx.Client(
+        proxy="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## 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!
+

pulse_python_sdk-0.0.52.dist-info/RECORD

@@ -0,0 +1,72 @@
+pulse/__init__.py,sha256=K1NGq3DqJIxpclZTQ5TtPKiCZVrwhR5DSZFQJVzGzXk,1285
+pulse/client.py,sha256=L13lZ4anycqMZsLJed7I058tWCW5ISErg5Rk7Iak4-U,26247
+pulse/core/__init__.py,sha256=oGy-hrWZlt5m1nGu3eG0-1kTEH2YuCWqqDxlLXFwv7E,1100
+pulse/core/api_error.py,sha256=44vPoTyWN59gonCIZMdzw7M1uspygiLnr3GNFOoVL2Q,614
+pulse/core/client_wrapper.py,sha256=dqp4O6rnfUihcJbrJMSUXZ-87HtsN5PY8RNPezS8agg,2838
+pulse/core/datetime_utils.py,sha256=nBys2IsYrhPdszxGKCNRPSOCwa-5DWOHG95FB8G9PKo,1047
+pulse/core/file.py,sha256=d4NNbX8XvXP32z8KpK2Xovv33nFfruIrpz0QWxlgpZk,2663
+pulse/core/force_multipart.py,sha256=cH981xLy0kZVKiZZkFoeUjgJ2Zuq7KXB2aRAnmHzRDc,477
+pulse/core/http_client.py,sha256=cXuS6t54TJ-rSGIGvZlYEz4d_CY8ulJy1thx1hAHoX4,25726
+pulse/core/http_response.py,sha256=A6URkoTBCiryctAA-m9EiDWOsHgM5oYAlcYVc_YOiiI,1330
+pulse/core/http_sse/__init__.py,sha256=vE7RxBmzIfV9SmFDw4YCuDN9DaPuJb3FAnoFDo7bqww,1350
+pulse/core/http_sse/_api.py,sha256=v7bcIkdawmL6Y39HxrM5OiEB1Ci3wzIdu21kCZII-mU,3920
+pulse/core/http_sse/_decoders.py,sha256=tY3L5TZ0y-pgz0Lu1q8ro5Ljz43q4lYyuec73u9WfNw,1733
+pulse/core/http_sse/_exceptions.py,sha256=o8Tp-e8Lvmtn_5MVSYbkW9rVrpwFg5pnKbOcHfrHH14,127
+pulse/core/http_sse/_models.py,sha256=kKvCCm8e6gCilulJpiHv4f2OPVxo9CydLboEqMhplPI,397
+pulse/core/jsonable_encoder.py,sha256=hGgcEEeX11sqxxsll7h15pO3pTNVxk_n79Kcn0laoWA,3655
+pulse/core/pydantic_utilities.py,sha256=fxp1jeDn1YbKXbVabl0hI9YeC3LtN8ZQ4HIICyFS8xg,10966
+pulse/core/query_encoder.py,sha256=ekulqNd0j8TgD7ox-Qbz7liqX8-KP9blvT9DsRCenYM,2144
+pulse/core/remove_none_from_dict.py,sha256=EU9SGgYidWq7SexuJbNs4-PZ-5Bl3Vppd864mS6vQZw,342
+pulse/core/request_options.py,sha256=h0QUNCFVdCW_7GclVySCAY2w4NhtXVBUCmHgmzaxpcg,1681
+pulse/core/serialization.py,sha256=ECL3bvv_0i7U4uvPidZCNel--MUbA0iq0aGcNKi3kws,9818
+pulse/core/unchecked_base_model.py,sha256=24eoPRbtEx2TAarwTmC6JiR0tM6QkmUbrVu7J0mWkE4,15006
+pulse/environment.py,sha256=32vp_3e7BnDsHMWNRrF-sV7dsDULFbC7Q5anenafkjA,152
+pulse/errors/__init__.py,sha256=_VhToAyIt_5axN6CLJwtxg3-CO7THa_23pbUzqhXJa4,85
+pulse/errors/bad_request_error.py,sha256=rmt2UyKLfCwaztIVmSogAAcv1dlEBZHjo06QurKWmiw,321
+pulse/errors/forbidden_error.py,sha256=7489eBXhYtjpap2ifhSc99N9o7v6evag0svQu_EQ4tM,320
+pulse/errors/internal_server_error.py,sha256=SQy3jeXTg5IpLev9opjUIDvq_33rwqQLXmiW2UJjW4k,325
+pulse/errors/not_found_error.py,sha256=7GQ0iCCRpVeg55InQsDsMMD3HomNjc4d-dHYWkUnZLw,319
+pulse/errors/too_many_requests_error.py,sha256=Qq5JyxITVwruL0_9kGS5TjlRVvudI_AdWXwz7Ku78xo,326
+pulse/errors/unauthorized_error.py,sha256=cDi1t15echZjvUjgAAUi-LwZozyBxKT4kw30tWL0x8U,323
+pulse/jobs/__init__.py,sha256=_VhToAyIt_5axN6CLJwtxg3-CO7THa_23pbUzqhXJa4,85
+pulse/jobs/client.py,sha256=2YRqPW-HHv3UdtJyqqaHX4bkZU3j1GlLgxkDNhihUwU,5357
+pulse/jobs/raw_client.py,sha256=hyQRBhI671nt3m882CRxqv-MROdWu_XQfFzT1_OiqNs,16238
+pulse/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pulse/raw_client.py,sha256=_8y8GV-vM0s0pdHPzMSsyHy7U5smrz1sBiikUMnOp7Q,30086
+pulse/types/__init__.py,sha256=_VhToAyIt_5axN6CLJwtxg3-CO7THa_23pbUzqhXJa4,85
+pulse/types/extract_async_input.py,sha256=WNG-G5JH8mF1DIXii29hOM3JOTk_FaKbwaGQn9m6ub4,111
+pulse/types/extract_async_response.py,sha256=DEmJ67COVxgkv1Q79Vns63ZVXAQYn-FI6lWmqptvHg8,1284
+pulse/types/extract_async_submission_response_status.py,sha256=u6geQ7SC3mEyvqYoJiUWAWLN-F3wwULq71kohSJueQ0,226
+pulse/types/extract_input.py,sha256=ch0NIdSIsQEmaWpDYxT2wYcecvcHoBikAS02wzI2NuI,106
+pulse/types/extract_json_input.py,sha256=ngFNLoh15DWWltAT5RLpOn5j0BNhBdl7CfABNPljdSg,4419
+pulse/types/extract_json_input_experimental_schema.py,sha256=OvSYPpo126Q8ayxBEzRI5UOaausJgexbBmT-A6UZ7v8,165
+pulse/types/extract_json_input_schema.py,sha256=gFReVhKIjJDm5Vn_sJDVYllKXZ4W947fiCMDm4RMBNQ,153
+pulse/types/extract_json_input_storage.py,sha256=0EdLx6opmbA-6ciJwgu9V_mwWuZAzDzEg1LrNyy87UM,1238
+pulse/types/extract_json_input_structured_output.py,sha256=bNFCwcIpajH5jZYy5xPG7xn4MCj333Dnaaat3-iRxMA,1244
+pulse/types/extract_multipart_input.py,sha256=50zUw0CKWULknFEbs28FZIsOgZqaqb8RQC7KU3VA6rA,4325
+pulse/types/extract_multipart_input_experimental_schema.py,sha256=oF3oZAtIyFURHBEfd8tlytFgSB3KIOyn3Qh3njPnYNA,170
+pulse/types/extract_multipart_input_schema.py,sha256=S8hZB-hkSdLwTKSJ-zkT4alep6yaXd1ZstpK8eGV79U,158
+pulse/types/extract_multipart_input_storage.py,sha256=CamBp_5eJySK7QE2xWK6zaT2FB301lgqII6mGSI5D5I,1243
+pulse/types/extract_multipart_input_structured_output.py,sha256=vUM-dpv05kquW_6XB8EnVtHkS3mqQgezDCcOHoA0p2g,1249
+pulse/types/extract_options.py,sha256=8q3J4BfeJsYZUvCMqIO-iZSqj3EJIB2Cw-_5JOrQSgA,4236
+pulse/types/extract_options_experimental_schema.py,sha256=BVOmwA0CzKSpMtWA7c36Juq2Q5Ej4FI_7XKWHVSyAh0,163
+pulse/types/extract_options_schema.py,sha256=sgddwR8MABnAj5eqg8i8VtbGCuKoIDFOpZGxD1w97cQ,151
+pulse/types/extract_options_storage.py,sha256=y07EpcTWZES_jXI4J6z5vvRTuEjRKeuK4Klc9cQDFP8,1236
+pulse/types/extract_options_structured_output.py,sha256=8KpuTGtmaYC8X4y-Uo5cPSruHQwKodNaBN28Kr5hPbs,1242
+pulse/types/extract_response.py,sha256=d7-LsDYp90583qHRL81wpC6leE6lTnR9XPxEzG8ncmI,1339
+pulse/types/extract_source_multipart_one.py,sha256=cTpkmRTKfokTvNAWk3qiDqPmm07eXtxQXaGThreCYS8,856
+pulse/types/extract_source_multipart_zero.py,sha256=bfAkUbstsY0Lr9TnadVE0FknJjvEd6LRFtJ8RiodX-E,823
+pulse/types/job_cancellation_response.py,sha256=-oGk4tlHPWXOuuK07dSGimCfu7imKLCk6TCzLMGm4Wg,833
+pulse/types/job_status.py,sha256=C8iXHDrugWWMnJ8o-6SvQTT3aOZD4FuAe3QAgPMGXco,193
+pulse/types/job_status_response.py,sha256=sFdqbuPgK0-SaKGHDNbRahi43aGlDnE3UZTCmKQJaXc,1408
+pulse/types/json_source.py,sha256=Dv8GXpfAid3URfigzOp7M0tVGHxWPG4C4hDioDb-kag,862
+pulse/types/multipart_source.py,sha256=3nbotmmkUeUjDINjgTPkGe1NfojCj-k4ywlktAwGWTg,305
+pulse/version.py,sha256=Fm3QIBgQla9gCQzBmukxfHxgNGpwhEwmvAH-WfCJ5T0,83
+pulse/webhooks/__init__.py,sha256=_VhToAyIt_5axN6CLJwtxg3-CO7THa_23pbUzqhXJa4,85
+pulse/webhooks/client.py,sha256=HRiH2iNoz5-N8b5PUpvZ8YbCYBrCEZhPkEJu4nnvdsU,3035
+pulse/webhooks/raw_client.py,sha256=TddIuwLCT4EdnS34iFSmaZ3TTwytlYsYRMZoKFLNGDQ,5573
+pulse/webhooks/types/__init__.py,sha256=_VhToAyIt_5axN6CLJwtxg3-CO7THa_23pbUzqhXJa4,85
+pulse/webhooks/types/create_webhook_link_response.py,sha256=9U-dtBqzQ4uh3I6PGb8FcyxOeLRDkMLBr56OT0FcZHk,643
+pulse_python_sdk-0.0.52.dist-info/METADATA,sha256=XVdfj_Ua7iLvQoQJMDli2S1OLSonJ0lAvKR0E5-mATk,5622
+pulse_python_sdk-0.0.52.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+pulse_python_sdk-0.0.52.dist-info/RECORD,,

pulse_python_sdk-0.0.52.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 1.6.1
+Root-Is-Purelib: true
+Tag: py3-none-any