mixpeek 0.2__py3-none-any.whl → 0.6.2__py3-none-any.whl

mixpeek-0.6.2.dist-info/METADATA

@@ -0,0 +1,145 @@
+Metadata-Version: 2.1
+Name: mixpeek
+Version: 0.6.2
+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
+
+# Mixpeek 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 Mixpeek Python Library provides convenient access to the Mixpeek API from applications written in Python.
+
+## Installation
+Add this dependency to your project's build file:
+
+```bash
+pip install mixpeek
+# or
+poetry add mixpeek
+```
+
+## Usage
+Simply import `Mixpeek` and start making calls to our API. 
+
+```python
+from mixpeek.client import Mixpeek
+
+client = Mixpeek(
+    api_key="..."
+)
+```
+
+## Async Client
+
+The SDK also exports an async client so that you can make non-blocking
+calls to our API. 
+
+```python
+from mixpeek.client import AsymcMixpeek
+
+client = AsyncMixpeek(
+    api_key="..."
+)
+```
+
+## Exception Handling
+All errors thrown by the SDK will be subclasses of [`ApiError`](./src/mixpeek/core/api_error.py).
+
+```python
+import mixpeek
+
+try:
+  client.search(...)
+except mixpeek.core.ApiError as e: # Handle all errors
+  print(e.status_code)
+  print(e.body)
+```
+
+## Advanced
+
+### Retries
+The Mixpeek 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.
+
+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)
+- [409](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/409) (Conflict)
+- [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
+from mixpeek.client import Mixpeek
+
+client = Mixpeek(...)
+
+# Override retries for a specific method
+client.search(..., {
+    max_retries=5
+})
+```
+
+### 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 mixpeek.client import Mixpeek
+
+client = Mixpeek(
+    # All timeouts are 20 seconds
+    timeout=20.0,
+)
+
+# Override timeout for a specific method
+client.search(..., {
+    timeout_in_seconds=20.0
+})
+```
+
+### 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 mixpeek.client import Mixpeek
+
+client = Mixpeek(
+    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 beta, and there may be breaking changes between versions without a major 
+version update. Therefore, we recommend pinning the package version to a specific version. 
+This way, you can install the same version each time without breaking changes.
+
+## 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!
+

mixpeek-0.6.2.dist-info/RECORD

@@ -0,0 +1,78 @@
+mixpeek/__init__.py,sha256=lUhNeNcGm17ibZbyMRdI-mRniA8Ez4Kl3te5eQfL6T8,2000
+mixpeek/base_client.py,sha256=wl8CUr8zcD2DWTQ45MIiJ3aTbuEbkW4nwMRxLnwl1e0,7338
+mixpeek/client.py,sha256=4FB09MxWYPm7ci7VBsuSYQvp-Fj6XWVaMmbcGg_J19o,2064
+mixpeek/core/__init__.py,sha256=RWfyDqkzWsf8e3VGc3NV60MovfJbg5XWzNFGB2DZ0hA,790
+mixpeek/core/api_error.py,sha256=RE8LELok2QCjABadECTvtDp7qejA1VmINCh6TbqPwSE,426
+mixpeek/core/client_wrapper.py,sha256=n0jL710h_e-Eheb8l0f5uGKnMI2xQzWJv7NAAAR2L-A,2622
+mixpeek/core/datetime_utils.py,sha256=nBys2IsYrhPdszxGKCNRPSOCwa-5DWOHG95FB8G9PKo,1047
+mixpeek/core/file.py,sha256=sy1RUGZ3aJYuw998bZytxxo6QdgKmlnlgBaMvwEKCGg,1480
+mixpeek/core/http_client.py,sha256=5ok6hqgZDJhg57EHvMnr0BBaHdG50QxFPKaCZ9aVWTc,5059
+mixpeek/core/jsonable_encoder.py,sha256=IEhJedBpobt0zOfjW0pcH_sptQH3_frWtRF_s6i4HTM,3799
+mixpeek/core/remove_none_from_dict.py,sha256=8m91FC3YuVem0Gm9_sXhJ2tGvP33owJJdrqCLEdowGw,330
+mixpeek/core/request_options.py,sha256=-3QoOMMHI2exIyHH6Q2MD7rpo_6w-i6zMAy0nqWTN8c,1420
+mixpeek/embed/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
+mixpeek/embed/client.py,sha256=haXcK4uwxnelQEu_CKExZTxX8axjIoHESdENm711xWk,16086
+mixpeek/environment.py,sha256=-muYBZQwCYNISO0ic3Kkn_hPqfrB_VpOv_RpBoCKA6Q,156
+mixpeek/errors/__init__.py,sha256=whc3hN4Au19m_MxwQGjxUEfmSPyHqjmvOS0ESc0S7Qk,534
+mixpeek/errors/bad_request_error.py,sha256=xHpPeLG8lM_kLR1QpOHI4xOuWVFEOgQfQi37kOcB0wc,285
+mixpeek/errors/forbidden_error.py,sha256=CYoHSeucV5tjDJUTj19Dp6EoJZBvRswNAT9YhITApfE,284
+mixpeek/errors/internal_server_error.py,sha256=fMmyOAEwUto7X9Mp65KbL0XkvepZsmT6p1p3hIBEuFg,289
+mixpeek/errors/not_found_error.py,sha256=y5TwirUAu_TWO2d1Poh2ALf1IHj2v728z6AxrGexSVg,283
+mixpeek/errors/unauthorized_error.py,sha256=nH-QOnS5KLta5PB4I-UoETY4i_Uz3-mF9xCwScE1JOE,287
+mixpeek/errors/unprocessable_entity_error.py,sha256=FvR7XPlV3Xx5nu8HNlmLhBRdk4so_gCHjYT5PyZe6sM,313
+mixpeek/extract/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
+mixpeek/extract/client.py,sha256=qaslz87C5K3kh1CVL9VTuhgWgOKVWk8ctavYpkrqcDI,15158
+mixpeek/generators/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
+mixpeek/generators/client.py,sha256=SzB9kLokmXDOzPAfeQIbmrcMtXYDoJ4LqqGAY8ELkzo,10251
+mixpeek/parse/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
+mixpeek/parse/client.py,sha256=Zav85ROBG9jmhi6JKwy0FAcpvddGlwwE4uDv4dZ7o4c,4717
+mixpeek/parse_client.py,sha256=yRhssnPCsjSKnS0LknhiYicAOuRcRnRVcn7iWaswQBU,279
+mixpeek/pipelines/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
+mixpeek/pipelines/client.py,sha256=giu5j2RBt4XbWWI4n9TBUxRUOEmsp1iDPSLU37utayg,22360
+mixpeek/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mixpeek/storage/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
+mixpeek/storage/client.py,sha256=Ug_1zg0KF3lMT2JIipiryHB3dikitt7-GIVxrzdKQow,12609
+mixpeek/types/__init__.py,sha256=frwgYFJuSzwu6UyATG--EvTATm81whup82khta72lFA,2060
+mixpeek/types/api_key.py,sha256=DnZf9eer296hvfC5PK4Hcrg7-LywKA_fSn68aaMzf5U,1013
+mixpeek/types/audio_params.py,sha256=3KowuNn3ClYTXWsFvKHd8XrR1G8hmydusRzQQ6cAp5I,939
+mixpeek/types/configs_response.py,sha256=_gH6KyKLlC6CZcJeJYFO0ecr7QLSpmgKJqlqxiLcXCQ,959
+mixpeek/types/connection.py,sha256=b2dw5xagRgTuGjBB_NSW0JsVeSWGiFwkM6-E3jQc9IA,1144
+mixpeek/types/connection_engine.py,sha256=Gy43bjrZTkfiYtQQZGZFvJwHvHS0PxhZCf8l-LRrbRE,168
+mixpeek/types/csv_params.py,sha256=Adc3qwAOGpvRRAu3iV6ObN5EbLPnzmsj8IxTyDc0ZCM,938
+mixpeek/types/destination.py,sha256=bylFUTAdnonbUw_V1wBF4cNEAsyzkkgwa3lY9U029Ko,945
+mixpeek/types/embedding_response.py,sha256=gQCNVHNVqYii4WLZisEbjkOllSaTwz3PxOhCBOe808Y,955
+mixpeek/types/error_message.py,sha256=8Wh_GdH3jOviv_FYLyzQH20qbFTSzKqqjdZlOe2tlbE,905
+mixpeek/types/error_response.py,sha256=SNectmi0OaoeWGAUvO7D0h40rf7jIEh3SLUtKxXs3ms,995
+mixpeek/types/field_type.py,sha256=ihpE7AL8NwS8mZ9ItVeK26KBmrIa0tLbCag96Pk4dqE,160
+mixpeek/types/generation_response.py,sha256=A07sNXlAY1sY3Cl7zajf4zZaZbdTPFpElg1oDf636P0,1117
+mixpeek/types/html_params.py,sha256=5wylzm01kSNgIgMFMGmgj93LCJpubrX0gp2NuKxjVYE,949
+mixpeek/types/http_validation_error.py,sha256=C6i5Fm74cECbzWUDvUDgAO9g9ryIFeKesoeqTUNakJc,1010
+mixpeek/types/image_params.py,sha256=zdeXR_-EGw_7MKOF1D2zilRFiYJWohDnLVTo1VwLa7U,1070
+mixpeek/types/message.py,sha256=21yebcf5X18U92khfedI-Gl02MkaBzDw4guLNy49bUk,918
+mixpeek/types/metadata.py,sha256=YA7JZx_s7ChSqBA5Ay-zt8cGszDGmQv8PElYzi5N02E,1147
+mixpeek/types/modality.py,sha256=GcEBlbYKdNs0qdyKnmrbgoDHyC1WYimv5PFKUjuI2jc,170
+mixpeek/types/model.py,sha256=mBXXY-K54nqGVqt7SnzAyZeDdoU7wVMzGrhM8XTAmx4,948
+mixpeek/types/models.py,sha256=RnTOybDVTkVIWrZRY18cULyqjGGTWE2ZJuYT0lYv5lo,173
+mixpeek/types/pdf_params.py,sha256=9RF3S2uuE4oyaoPlRfI52phqWyD8ViOz6tl25HXBlek,1646
+mixpeek/types/ppt_params.py,sha256=FS9BjjiZStDhGtaImv8uz9lhQG6r6a9gBiUJsPzhca0,888
+mixpeek/types/pptx_params.py,sha256=W2hrSVvYjRxDrClFRoZKmM0dSb0YbCOjjT5dBiJMkZw,889
+mixpeek/types/settings.py,sha256=F_KpO1F5_yHyRXQr7SPn7QIjVa05ViiyXShlB_ODKsI,1223
+mixpeek/types/source.py,sha256=Dq0CGXa3tyfe01L-d4si02j6YavQ3PQj9N_KkYuMsCk,998
+mixpeek/types/source_destination_mapping.py,sha256=2CTDTYcPbxUco8m_9ebbZ4xQ2_piylkRQeO5fFvdDkM,1041
+mixpeek/types/txt_params.py,sha256=nongbYA0BWr4kHvNBDdA6yoNkg6TXTsP2AG3tstyLd8,888
+mixpeek/types/user.py,sha256=bZ4ROKzi-5c8pfHQ-nvM445m_d3p9DK-OjTbGhXY1-w,1249
+mixpeek/types/validation_error.py,sha256=dy6Ev1xmAsX_Wcck5AX8XvcVNP5xA-Lwlt7FTceiYqs,1029
+mixpeek/types/validation_error_loc_item.py,sha256=LAtjCHIllWRBFXvAZ5QZpp7CPXjdtN9EB7HrLVo6EP0,128
+mixpeek/types/video_params.py,sha256=SJlONUkncIVzFz37Q8iNNznYd10hdLgrMnRmxT5yz5E,890
+mixpeek/types/workflow_response.py,sha256=t3fhcd780TUiCbFmX-2hRQY9oajjdE6g8AOy-lVS95A,1059
+mixpeek/types/workflow_settings.py,sha256=1YXWRIJUxra85keIOglvJra62rItRyuH8PYcG3pgRvE,1003
+mixpeek/types/xlsx_params.py,sha256=SXGQe3KhevNEdxjqIxxHmmuBrrk4IBetEcFaHq-_zQA,939
+mixpeek/users/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
+mixpeek/users/client.py,sha256=Fv01PY1J6mbuaCJPdKr97eONPcmLqzT6q9kuyNfjlSQ,14911
+mixpeek/version.py,sha256=DfAuS0W7koTv3v8TZFxY1W5LvfaqOvG96P6Kc5fNnU0,75
+mixpeek/workflows/__init__.py,sha256=FTtvy8EDg9nNNg9WCatVgKTRYV8-_v1roeGPAKoa_pw,65
+mixpeek/workflows/client.py,sha256=lDfSwYGPSMx9enKzPMKObdL93pFn6ByZH04F83cz9jA,24370
+mixpeek-0.6.2.dist-info/LICENSE,sha256=4Wv5VxfDWkCcIouCfq1NrLwPm24Z83PE8Nbi3KyoEeg,1064
+mixpeek-0.6.2.dist-info/METADATA,sha256=YsLQiIOSjceSER6cNNRlJXFlpYQ78bCLOnPqWhoUWUg,3985
+mixpeek-0.6.2.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+mixpeek-0.6.2.dist-info/RECORD,,

{mixpeek-0.2.dist-info → mixpeek-0.6.2.dist-info}/WHEEL

@@ -1,5 +1,4 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: poetry-core 1.6.1
 Root-Is-Purelib: true
 Tag: py3-none-any
-

mixpeek-0.2.dist-info/METADATA

@@ -1,12 +0,0 @@
-Metadata-Version: 2.1
-Name: mixpeek
-Version: 0.2
-Summary: full-text file search API
-Home-page: https://github.com/mixpeek/mixpeek-python
-Author: Ethan Steininger
-Author-email: info@mixpeek.com
-License: MIT
-Keywords: file search
-License-File: LICENSE.rst
-Requires-Dist: requests
-

mixpeek-0.2.dist-info/RECORD

@@ -1,6 +0,0 @@
-mixpeek/__init__.py,sha256=kvX2oPwa29M4iz8aHDRONX9JJDoK_AGAPau5_9NdNE0,2446
-mixpeek-0.2.dist-info/LICENSE.rst,sha256=HHFCinDHL38osjHNrBgNZqExYuEWJ3hNZxzcr1mWWeo,1072
-mixpeek-0.2.dist-info/METADATA,sha256=TS84KKiJVMhaN1ETyg8-OKIgZdyuXVVlVAJd23C9QQA,279
-mixpeek-0.2.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-mixpeek-0.2.dist-info/top_level.txt,sha256=EJ8Jc4IhqyUwnUlBwKbs498Ju4O9a-IDh2kXc_lo6Vg,8
-mixpeek-0.2.dist-info/RECORD,,

mixpeek-0.2.dist-info/top_level.txt

@@ -1 +0,0 @@
-mixpeek