udl-sdk 0.1.0a1__py3-none-any.whl

udl_sdk-0.1.0a1.dist-info/METADATA

@@ -0,0 +1,462 @@
+Metadata-Version: 2.3
+Name: udl-sdk
+Version: 0.1.0a1
+Summary: The official Python library for the unifieddatalibrary API
+Project-URL: Homepage, https://github.com/rsivilli-bluestaq/udl-python-sdk
+Project-URL: Repository, https://github.com/rsivilli-bluestaq/udl-python-sdk
+Author-email: Unifieddatalibrary <unifieddatalibrary@bluestaq.com>
+License: Apache-2.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software 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
+
+# Unifieddatalibrary Python API library
+
+[![PyPI version](https://img.shields.io/pypi/v/udl-sdk.svg)](https://pypi.org/project/udl-sdk/)
+
+The Unifieddatalibrary Python library provides convenient access to the Unifieddatalibrary 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.unifieddatalibrary.com](https://docs.unifieddatalibrary.com). The full API of this library can be found in [api.md](https://github.com/rsivilli-bluestaq/udl-python-sdk/tree/main/api.md).
+
+## Installation
+
+```sh
+# install from PyPI
+pip install --pre udl-sdk
+```
+
+## Usage
+
+The full API of this library can be found in [api.md](https://github.com/rsivilli-bluestaq/udl-python-sdk/tree/main/api.md).
+
+```python
+import os
+from unifieddatalibrary import Unifieddatalibrary
+
+client = Unifieddatalibrary(
+    username=os.environ.get("UDL_AUTH_USERNAME"),  # This is the default and can be omitted
+    password=os.environ.get("UDL_AUTH_PASSWORD"),  # This is the default and can be omitted
+)
+
+conjunction_full = client.conjunctions.retrieve(
+    "id",
+)
+print(conjunction_full.id)
+```
+
+While you can provide a `username` keyword argument,
+we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
+to add `UDL_AUTH_USERNAME="My Username"` to your `.env` file
+so that your Username is not stored in source control.
+
+## Async usage
+
+Simply import `AsyncUnifieddatalibrary` instead of `Unifieddatalibrary` and use `await` with each API call:
+
+```python
+import os
+import asyncio
+from unifieddatalibrary import AsyncUnifieddatalibrary
+
+client = AsyncUnifieddatalibrary(
+    username=os.environ.get("UDL_AUTH_USERNAME"),  # This is the default and can be omitted
+    password=os.environ.get("UDL_AUTH_PASSWORD"),  # This is the default and can be omitted
+)
+
+
+async def main() -> None:
+    conjunction_full = await client.conjunctions.retrieve(
+        "id",
+    )
+    print(conjunction_full.id)
+
+
+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`.
+
+from datetime import datetime, date
+
+## Nested params
+
+Nested parameters are dictionaries, typed using `TypedDict`, for example:
+
+```python
+from unifieddatalibrary import Unifieddatalibrary
+
+client = Unifieddatalibrary()
+
+client.aircraft.create(
+    aircraft_mds="E-2C HAWKEYE",
+    classification_marking="U",
+    data_mode="TEST",
+    source="Bluestaq",
+    entity={
+        "classification_marking": "U",
+        "data_mode": "TEST",
+        "name": "Example name",
+        "source": "Bluestaq",
+        "type": "ONORBIT",
+        "country_code": "US",
+        "id_entity": "ENTITY-ID",
+        "id_location": "LOCATION-ID",
+        "id_on_orbit": "ONORBIT-ID",
+        "id_operating_unit": "OPERATINGUNIT-ID",
+        "location": {
+            "classification_marking": "U",
+            "data_mode": "TEST",
+            "name": "Example location",
+            "source": "Bluestaq",
+            "altitude": 10.23,
+            "country_code": "US",
+            "id_location": "LOCATION-ID",
+            "lat": 45.23,
+            "lon": 179.1,
+            "origin": "THIRD_PARTY_DATASOURCE",
+        },
+        "on_orbit": {
+            "classification_marking": "U",
+            "data_mode": "TEST",
+            "sat_no": 1,
+            "source": "Bluestaq",
+            "alt_name": "Alternate Name",
+            "category": "Lunar",
+            "common_name": "Example common name",
+            "constellation": "Big Dipper",
+            "country_code": "US",
+            "decay_date": datetime.fromisoformat("2018-01-01T16:00:00.123"),
+            "id_on_orbit": "ONORBIT-ID",
+            "intl_des": "2021123ABC",
+            "launch_date": date.fromisoformat("2018-01-01"),
+            "launch_site_id": "LAUNCHSITE-ID",
+            "lifetime_years": 10,
+            "mission_number": "Expedition 1",
+            "object_type": "PAYLOAD",
+            "origin": "THIRD_PARTY_DATASOURCE",
+        },
+        "origin": "THIRD_PARTY_DATASOURCE",
+        "owner_type": "Commercial",
+        "taskable": False,
+        "urls": ["URL1", "URL2"],
+    },
+)
+```
+
+## File uploads
+
+Request parameters that correspond to file uploads can be passed as `bytes`, or a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance or a tuple of `(filename, contents, media type)`.
+
+```python
+from pathlib import Path
+from unifieddatalibrary import Unifieddatalibrary
+
+client = Unifieddatalibrary()
+
+client.analytic_imagery.unvalidated_publish(
+    file=Path("/path/to/file"),
+)
+```
+
+The async client uses the exact same interface. If you pass a [`PathLike`](https://docs.python.org/3/library/os.html#os.PathLike) instance, the file contents will be read asynchronously automatically.
+
+## 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 `unifieddatalibrary.APIConnectionError` is raised.
+
+When the API returns a non-success status code (that is, 4xx or 5xx
+response), a subclass of `unifieddatalibrary.APIStatusError` is raised, containing `status_code` and `response` properties.
+
+All errors inherit from `unifieddatalibrary.APIError`.
+
+```python
+import unifieddatalibrary
+from unifieddatalibrary import Unifieddatalibrary
+
+client = Unifieddatalibrary()
+
+try:
+    client.conjunctions.retrieve(
+        "id",
+    )
+except unifieddatalibrary.APIConnectionError as e:
+    print("The server could not be reached")
+    print(e.__cause__)  # an underlying Exception, likely raised within httpx.
+except unifieddatalibrary.RateLimitError as e:
+    print("A 429 status code was received; we should back off a bit.")
+except unifieddatalibrary.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 unifieddatalibrary import Unifieddatalibrary
+
+# Configure the default for all requests:
+client = Unifieddatalibrary(
+    # default is 2
+    max_retries=0,
+)
+
+# Or, configure per-request:
+client.with_options(max_retries=5).conjunctions.retrieve(
+    "id",
+)
+```
+
+### 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 unifieddatalibrary import Unifieddatalibrary
+
+# Configure the default for all requests:
+client = Unifieddatalibrary(
+    # 20 seconds (default is 1 minute)
+    timeout=20.0,
+)
+
+# More granular control:
+client = Unifieddatalibrary(
+    timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
+)
+
+# Override per-request:
+client.with_options(timeout=5.0).conjunctions.retrieve(
+    "id",
+)
+```
+
+On timeout, an `APITimeoutError` is thrown.
+
+Note that requests that time out are [retried twice by default](https://github.com/rsivilli-bluestaq/udl-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 `UNIFIEDDATALIBRARY_LOG` to `info`.
+
+```shell
+$ export UNIFIEDDATALIBRARY_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 unifieddatalibrary import Unifieddatalibrary
+
+client = Unifieddatalibrary()
+response = client.conjunctions.with_raw_response.retrieve(
+    "id",
+)
+print(response.headers.get('X-My-Header'))
+
+conjunction = response.parse()  # get the object that `conjunctions.retrieve()` would have returned
+print(conjunction.id)
+```
+
+These methods return an [`APIResponse`](https://github.com/rsivilli-bluestaq/udl-python-sdk/tree/main/src/unifieddatalibrary/_response.py) object.
+
+The async client returns an [`AsyncAPIResponse`](https://github.com/rsivilli-bluestaq/udl-python-sdk/tree/main/src/unifieddatalibrary/_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.conjunctions.with_streaming_response.retrieve(
+    "id",
+) 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 unifieddatalibrary import Unifieddatalibrary, DefaultHttpxClient
+
+client = Unifieddatalibrary(
+    # Or use the `UNIFIEDDATALIBRARY_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 unifieddatalibrary import Unifieddatalibrary
+
+with Unifieddatalibrary() 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/rsivilli-bluestaq/udl-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 unifieddatalibrary
+print(unifieddatalibrary.__version__)
+```
+
+## Requirements
+
+Python 3.8 or higher.
+
+## Contributing
+
+See [the contributing documentation](https://github.com/rsivilli-bluestaq/udl-python-sdk/tree/main/./CONTRIBUTING.md).