hubmap-search-sdk 1.0.0a1__py3-none-any.whl

hubmap_search_sdk-1.0.0a1.dist-info/METADATA

@@ -0,0 +1,355 @@
+Metadata-Version: 2.3
+Name: hubmap_search_sdk
+Version: 1.0.0a1
+Summary: The official Python library for the hubmap-search-sdk API
+Project-URL: Homepage, https://github.com/hubmapconsortium/search-python-sdk
+Project-URL: Repository, https://github.com/hubmapconsortium/search-python-sdk
+Author-email: Hubmap Search SDK <help@hubmapconsortium.org>
+License: MIT
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+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 :: 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-Python: >=3.8
+Requires-Dist: anyio<5,>=3.5.0
+Requires-Dist: distro<2,>=1.7.0
+Requires-Dist: httpx<1,>=0.23.0
+Requires-Dist: pydantic<3,>=1.9.0
+Requires-Dist: sniffio
+Requires-Dist: typing-extensions<5,>=4.10
+Description-Content-Type: text/markdown
+
+# Hubmap Search SDK Python API library
+
+[![PyPI version](https://img.shields.io/pypi/v/hubmap_search_sdk.svg)](https://pypi.org/project/hubmap_search_sdk/)
+
+The Hubmap Search SDK Python library provides convenient access to the Hubmap Search SDK REST API from any Python 3.8+
+application. The library includes type definitions for all request params and response fields,
+and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
+
+It is generated with [Stainless](https://www.stainless.com/).
+
+## Documentation
+
+The REST API documentation can be found on [docs.hubmapconsortium.org](https://docs.hubmapconsortium.org/clt/generate-manifest.html). The full API of this library can be found in [api.md](https://github.com/hubmapconsortium/search-python-sdk/tree/main/api.md).
+
+## Installation
+
+```sh
+# install from PyPI
+pip install --pre hubmap_search_sdk
+```
+
+## Usage
+
+The full API of this library can be found in [api.md](https://github.com/hubmapconsortium/search-python-sdk/tree/main/api.md).
+
+```python
+from hubmap_search_sdk import HubmapSearchSDK
+
+client = HubmapSearchSDK(
+    bearer_token="My Bearer Token",
+)
+
+indices = client.indices.list()
+print(indices.indices)
+```
+
+## Async usage
+
+Simply import `AsyncHubmapSearchSDK` instead of `HubmapSearchSDK` and use `await` with each API call:
+
+```python
+import asyncio
+from hubmap_search_sdk import AsyncHubmapSearchSDK
+
+client = AsyncHubmapSearchSDK(
+    bearer_token="My Bearer Token",
+)
+
+
+async def main() -> None:
+    indices = await client.indices.list()
+    print(indices.indices)
+
+
+asyncio.run(main())
+```
+
+Functionality between the synchronous and asynchronous clients is otherwise identical.
+
+## Using types
+
+Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:
+
+- Serializing back into JSON, `model.to_json()`
+- Converting to a dictionary, `model.to_dict()`
+
+Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
+
+## Handling errors
+
+When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `hubmap_search_sdk.APIConnectionError` is raised.
+
+When the API returns a non-success status code (that is, 4xx or 5xx
+response), a subclass of `hubmap_search_sdk.APIStatusError` is raised, containing `status_code` and `response` properties.
+
+All errors inherit from `hubmap_search_sdk.APIError`.
+
+```python
+import hubmap_search_sdk
+from hubmap_search_sdk import HubmapSearchSDK
+
+client = HubmapSearchSDK()
+
+try:
+    client.indices.list()
+except hubmap_search_sdk.APIConnectionError as e:
+    print("The server could not be reached")
+    print(e.__cause__)  # an underlying Exception, likely raised within httpx.
+except hubmap_search_sdk.RateLimitError as e:
+    print("A 429 status code was received; we should back off a bit.")
+except hubmap_search_sdk.APIStatusError as e:
+    print("Another non-200-range status code was received")
+    print(e.status_code)
+    print(e.response)
+```
+
+Error codes are as follows:
+
+| Status Code | Error Type                 |
+| ----------- | -------------------------- |
+| 400         | `BadRequestError`          |
+| 401         | `AuthenticationError`      |
+| 403         | `PermissionDeniedError`    |
+| 404         | `NotFoundError`            |
+| 422         | `UnprocessableEntityError` |
+| 429         | `RateLimitError`           |
+| >=500       | `InternalServerError`      |
+| N/A         | `APIConnectionError`       |
+
+### Retries
+
+Certain errors are automatically retried 2 times by default, with a short exponential backoff.
+Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
+429 Rate Limit, and >=500 Internal errors are all retried by default.
+
+You can use the `max_retries` option to configure or disable retry settings:
+
+```python
+from hubmap_search_sdk import HubmapSearchSDK
+
+# Configure the default for all requests:
+client = HubmapSearchSDK(
+    # default is 2
+    max_retries=0,
+)
+
+# Or, configure per-request:
+client.with_options(max_retries=5).indices.list()
+```
+
+### Timeouts
+
+By default requests time out after 1 minute. You can configure this with a `timeout` option,
+which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:
+
+```python
+from hubmap_search_sdk import HubmapSearchSDK
+
+# Configure the default for all requests:
+client = HubmapSearchSDK(
+    # 20 seconds (default is 1 minute)
+    timeout=20.0,
+)
+
+# More granular control:
+client = HubmapSearchSDK(
+    timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
+)
+
+# Override per-request:
+client.with_options(timeout=5.0).indices.list()
+```
+
+On timeout, an `APITimeoutError` is thrown.
+
+Note that requests that time out are [retried twice by default](https://github.com/hubmapconsortium/search-python-sdk/tree/main/#retries).
+
+## Advanced
+
+### Logging
+
+We use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.
+
+You can enable logging by setting the environment variable `HUBMAP_SEARCH_SDK_LOG` to `info`.
+
+```shell
+$ export HUBMAP_SEARCH_SDK_LOG=info
+```
+
+Or to `debug` for more verbose logging.
+
+### How to tell whether `None` means `null` or missing
+
+In an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:
+
+```py
+if response.my_field is None:
+  if 'my_field' not in response.model_fields_set:
+    print('Got json like {}, without a "my_field" key present at all.')
+  else:
+    print('Got json like {"my_field": null}.')
+```
+
+### Accessing raw response data (e.g. headers)
+
+The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,
+
+```py
+from hubmap_search_sdk import HubmapSearchSDK
+
+client = HubmapSearchSDK()
+response = client.indices.with_raw_response.list()
+print(response.headers.get('X-My-Header'))
+
+index = response.parse()  # get the object that `indices.list()` would have returned
+print(index.indices)
+```
+
+These methods return an [`APIResponse`](https://github.com/hubmapconsortium/search-python-sdk/tree/main/src/hubmap_search_sdk/_response.py) object.
+
+The async client returns an [`AsyncAPIResponse`](https://github.com/hubmapconsortium/search-python-sdk/tree/main/src/hubmap_search_sdk/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
+
+#### `.with_streaming_response`
+
+The above interface eagerly reads the full response body when you make the request, which may not always be what you want.
+
+To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
+
+```python
+with client.indices.with_streaming_response.list() as response:
+    print(response.headers.get("X-My-Header"))
+
+    for line in response.iter_lines():
+        print(line)
+```
+
+The context manager is required so that the response will reliably be closed.
+
+### Making custom/undocumented requests
+
+This library is typed for convenient access to the documented API.
+
+If you need to access undocumented endpoints, params, or response properties, the library can still be used.
+
+#### Undocumented endpoints
+
+To make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other
+http verbs. Options on the client will be respected (such as retries) when making this request.
+
+```py
+import httpx
+
+response = client.post(
+    "/foo",
+    cast_to=httpx.Response,
+    body={"my_param": True},
+)
+
+print(response.headers.get("x-foo"))
+```
+
+#### Undocumented request params
+
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request
+options.
+
+#### Undocumented response properties
+
+To access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You
+can also get all the extra fields on the Pydantic model as a dict with
+[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).
+
+### Configuring the HTTP client
+
+You can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:
+
+- Support for [proxies](https://www.python-httpx.org/advanced/proxies/)
+- Custom [transports](https://www.python-httpx.org/advanced/transports/)
+- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality
+
+```python
+import httpx
+from hubmap_search_sdk import HubmapSearchSDK, DefaultHttpxClient
+
+client = HubmapSearchSDK(
+    # Or use the `HUBMAP_SEARCH_SDK_BASE_URL` env var
+    base_url="http://my.test.server.example.com:8083",
+    http_client=DefaultHttpxClient(
+        proxy="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+You can also customize the client on a per-request basis by using `with_options()`:
+
+```python
+client.with_options(http_client=DefaultHttpxClient(...))
+```
+
+### Managing HTTP resources
+
+By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.
+
+```py
+from hubmap_search_sdk import HubmapSearchSDK
+
+with HubmapSearchSDK() as client:
+  # make requests here
+  ...
+
+# HTTP client is now closed
+```
+
+## Versioning
+
+This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
+
+1. Changes that only affect static types, without breaking runtime behavior.
+2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_
+3. Changes that we do not expect to impact the vast majority of users in practice.
+
+We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
+
+We are keen for your feedback; please open an [issue](https://www.github.com/hubmapconsortium/search-python-sdk/issues) with questions, bugs, or suggestions.
+
+### Determining the installed version
+
+If you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version.
+
+You can determine the version that is being used at runtime with:
+
+```py
+import hubmap_search_sdk
+print(hubmap_search_sdk.__version__)
+```
+
+## Requirements
+
+Python 3.8 or higher.
+
+## Contributing
+
+See [the contributing documentation](https://github.com/hubmapconsortium/search-python-sdk/tree/main/./CONTRIBUTING.md).

hubmap_search_sdk-1.0.0a1.dist-info/RECORD

@@ -0,0 +1,54 @@
+hubmap_search_sdk/__init__.py,sha256=eUNBFfdHquxHRjxdtY6YQ0pw-jeQuVT7fm5mtYzB8hY,2545
+hubmap_search_sdk/_base_client.py,sha256=igIM7x0E4s4sx9L5JZHR-lYleo68KIm8PxqyrGuaxyU,64968
+hubmap_search_sdk/_client.py,sha256=_B5lY2StPqLRgECImsspnws_3o0WbTfeMwZvhZTLRfo,19485
+hubmap_search_sdk/_compat.py,sha256=VWemUKbj6DDkQ-O4baSpHVLJafotzeXmCQGJugfVTIw,6580
+hubmap_search_sdk/_constants.py,sha256=S14PFzyN9-I31wiV7SmIlL5Ga0MLHxdvegInGdXH7tM,462
+hubmap_search_sdk/_exceptions.py,sha256=TSu_vsDWiUzuD0Dfn2RJxjxeGl4RJBR2Sblmd-0cGho,3238
+hubmap_search_sdk/_files.py,sha256=mf4dOgL4b0ryyZlbqLhggD3GVgDf6XxdGFAgce01ugE,3549
+hubmap_search_sdk/_models.py,sha256=Bg-k8-T1kDWURAYXrbDF5FSAyLEy7k90Jrvne-dF4Wc,29070
+hubmap_search_sdk/_qs.py,sha256=AOkSz4rHtK4YI3ZU_kzea-zpwBUgEY8WniGmTPyEimc,4846
+hubmap_search_sdk/_resource.py,sha256=z9CsPEtCJP9np1GfCrGKkqUmlGd10QdY9ZtINq4vyIs,1154
+hubmap_search_sdk/_response.py,sha256=V9jyjwgBvmdB9MqltIZFs4gLcdbj1MmLdhwS-ILkBSk,28881
+hubmap_search_sdk/_streaming.py,sha256=Anm1GDFtbRi3IL4NaaajTXDlwv75_Rm-bi6TD_0tSxU,10136
+hubmap_search_sdk/_types.py,sha256=Xxqpn7vIdO1HG3-TJaQdHFEI1etNZxdSS3QOOeakw0A,6154
+hubmap_search_sdk/_version.py,sha256=l1ee3X3YOUwHDne6K0B2J6w8GP6H49gzeptXUjocexg,177
+hubmap_search_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+hubmap_search_sdk/_utils/__init__.py,sha256=PNZ_QJuzZEgyYXqkO1HVhGkj5IU9bglVUcw7H-Knjzw,2062
+hubmap_search_sdk/_utils/_logs.py,sha256=vEolshfk2D36E9yV2JC0vIbMfBmiM-lIAw-ledyLVVI,807
+hubmap_search_sdk/_utils/_proxy.py,sha256=z3zsateHtb0EARTWKk8QZNHfPkqJbqwd1lM993LBwGE,1902
+hubmap_search_sdk/_utils/_reflection.py,sha256=ZmGkIgT_PuwedyNBrrKGbxoWtkpytJNU1uU4QHnmEMU,1364
+hubmap_search_sdk/_utils/_streams.py,sha256=SMC90diFFecpEg_zgDRVbdR3hSEIgVVij4taD-noMLM,289
+hubmap_search_sdk/_utils/_sync.py,sha256=TpGLrrhRNWTJtODNE6Fup3_k7zrWm1j2RlirzBwre-0,2862
+hubmap_search_sdk/_utils/_transform.py,sha256=asrbdx4Pf5NupzaB8QdEjypW_DgHjjkpswHT0Jum4S0,13987
+hubmap_search_sdk/_utils/_typing.py,sha256=nTJz0jcrQbEgxwy4TtAkNxuU0QHHlmc6mQtA6vIR8tg,4501
+hubmap_search_sdk/_utils/_utils.py,sha256=8UmbPOy_AAr2uUjjFui-VZSrVBHRj6bfNEKRp5YZP2A,12004
+hubmap_search_sdk/lib/.keep,sha256=wuNrz-5SXo3jJaJOJgz4vFHM41YH_g20F5cRQo0vLes,224
+hubmap_search_sdk/resources/__init__.py,sha256=in53qeBTsjQ4j4Gy2lRL9ptQbjduHnnROAmu6IbragQ,4761
+hubmap_search_sdk/resources/add.py,sha256=PYknHcgJRZTfwB4DVu2EmOreQ6TtdAX37vDYwnRQASc,14304
+hubmap_search_sdk/resources/clear_docs.py,sha256=AVGciD1yMMzVFl6qhClqRQ577KqWMaGpvgFoKXF4nYI,13287
+hubmap_search_sdk/resources/indices.py,sha256=-MvJfXZX7LGDJA1IR_zZwYgssbETKd0lCTP8ujsQifI,5347
+hubmap_search_sdk/resources/mapping.py,sha256=awjJkfSAiGA5U4HvQKTtlTk2C12wAHGnZT0ACsWLK7w,8095
+hubmap_search_sdk/resources/mget.py,sha256=iCrx34QHJqSZg74k94Wmf38jBTUkZ6SN4xjusRA_Gkc,10636
+hubmap_search_sdk/resources/param_search.py,sha256=SEEmGM2DrUhL7yGucxqOo-LeBbzHBlTu6UhGq4BkLmE,7984
+hubmap_search_sdk/resources/reindex.py,sha256=lNCNQkvzyvENMMCxQzmn8Dy-d364tN7KIahfv0KhnQM,5971
+hubmap_search_sdk/resources/scroll_search.py,sha256=xC_hZRlqYDgH310I_sSGnduEw7IBL1OE5Xy88NMlUxk,7064
+hubmap_search_sdk/resources/search.py,sha256=FJguv91ED8igVa87r_yG5UJ6HXV6eKcm8tgI65kOT_Q,13071
+hubmap_search_sdk/resources/update.py,sha256=tQ4CRYi_lvZ4kihDaHKAKdym4iRiigW2AYawReYGfP0,14469
+hubmap_search_sdk/types/__init__.py,sha256=ZdTuvNr3rYL5PZq_w2tTDI2KmPsFRGRBWg09qNhdFAA,1520
+hubmap_search_sdk/types/add_create_document_params.py,sha256=8xti5XGKIJOMavBOjlI1qvl0E75CC-9YvMPIqnmBANk,296
+hubmap_search_sdk/types/add_create_document_with_index_params.py,sha256=Ge4KWrTOw3i0cHGWPRY3uaKnIlF5OQawUq8asZJhigI,339
+hubmap_search_sdk/types/add_update_document_with_scope_params.py,sha256=XB_seJVZjRDgpVzcsmQKJNHOkLykdSY4YZUPGRx_J2Y,365
+hubmap_search_sdk/types/index_list_response.py,sha256=I98C_5Nf3M8EGKr_8-pbc3TAGhuJ-slR01eQv1B-CUc,265
+hubmap_search_sdk/types/mget_retrieve_multiple_by_index_params.py,sha256=0Iy4HdkmJARvYWxJliMycw6vfBK89DnRa0EpNULzDPA,316
+hubmap_search_sdk/types/mget_retrieve_multiple_params.py,sha256=hbc_-mZEXmxpNLOTdPulAw1sDRC8b24xacYbaAzSCis,302
+hubmap_search_sdk/types/param_search_execute_params.py,sha256=DcRJxEb6elfCsIpDJ2Kncfut21SfwE-IZA0qKqhtF9o,616
+hubmap_search_sdk/types/scroll_search_create_params.py,sha256=ahpdwN-Uyc_3o_W8e5FMDOiwkjftu1K1663fdP3k598,298
+hubmap_search_sdk/types/search_execute_index_query_params.py,sha256=mS5kqYkiS4IXF33O9tmvwmb1PRXLUOlQJs9APtkAEQM,664
+hubmap_search_sdk/types/search_execute_query_params.py,sha256=La2udYbqLYPTzIRJttGOe_ZZEhQHo0B4uYsRIF3cuMo,654
+hubmap_search_sdk/types/update_update_document_at_index_params.py,sha256=F6bL-5xzqfI1ClajCan9M2pWhKyP2qFENNXHE1unj54,341
+hubmap_search_sdk/types/update_update_document_params.py,sha256=LM65ha6n6USOen2DqlL8R0N8APX9uAduWzqReXqJWOI,302
+hubmap_search_sdk/types/update_update_document_with_scope_params.py,sha256=3Se48DT25C8gP_yvEoYWMg0whAD9qWPWMQH1rpvg8Zc,371
+hubmap_search_sdk-1.0.0a1.dist-info/METADATA,sha256=vuA8OdTro0wFfHwIcMLc22zr9efQFa9Tyc74cCS8K-I,12673
+hubmap_search_sdk-1.0.0a1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+hubmap_search_sdk-1.0.0a1.dist-info/licenses/LICENSE,sha256=lLxIB8m5gVPdScdg81tBYiNbRkVgIBWcmAN1yJwrOME,1057
+hubmap_search_sdk-1.0.0a1.dist-info/RECORD,,

hubmap_search_sdk-1.0.0a1.dist-info/WHEEL

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

hubmap_search_sdk-1.0.0a1.dist-info/licenses/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2025 hubmap-search-sdk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.