udl-sdk 0.1.0a1__tar.gz

udl_sdk-0.1.0a1/.gitignore

@@ -0,0 +1,16 @@
+.prism.log
+.vscode
+_dev
+
+__pycache__
+.mypy_cache
+
+dist
+
+.venv
+.idea
+
+.env
+.envrc
+codegen.log
+Brewfile.lock.json

udl_sdk-0.1.0a1/.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  ".": "0.1.0-alpha.1"
+}

udl_sdk-0.1.0a1/CHANGELOG.md

@@ -0,0 +1,65 @@
+# Changelog
+
+## 0.1.0-alpha.1 (2025-04-17)
+
+Full Changelog: [v0.0.1-alpha.0...v0.1.0-alpha.1](https://github.com/rsivilli-bluestaq/udl-python-sdk/compare/v0.0.1-alpha.0...v0.1.0-alpha.1)
+
+### Features
+
+* **api:** add pagination config and root security ([3d1a246](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/3d1a24685c1b27a3b54ca95a6c5d463a2ec7d5e5))
+* **api:** Adding transformation hack for endpoints that don't really accept json payloads ([c89b25f](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/c89b25f86fa650bd2d27fd9e3ab6e0daaf5d00da))
+* **api:** api update ([04586d6](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/04586d63bbae4605c21ef454e550b033ed728f66))
+* **api:** api update ([fb8fe0b](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/fb8fe0bdbd1daa69585faa4de27bbc26ae755314))
+* **api:** api update ([e01827e](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/e01827e30b53f9867244a775773016e896d812a1))
+* **api:** Config update for rsivilli-bluestaq/dev ([6a01d62](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/6a01d62a03b1ca7f75b858c8b1c68d9a4494b4fd))
+* **api:** manual updates ([d0480d1](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/d0480d1439dfd4941092f780e737bf477f3f23dd))
+* **api:** manual updates ([8330ba7](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/8330ba75b4b63ea0caf4801fe8bc842278fed25e))
+* **api:** manual updates ([97f4aca](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/97f4aca3cc01480a6199adc5282b806000dd0b1d))
+* **api:** manual updates ([e1be51a](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/e1be51a4693f5ad90f4d91c11a49558239f331aa))
+* **api:** manual updates ([344025e](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/344025e89c80f533546fa933ed687ca8bb655067))
+* **api:** removing historical flightplan ([e1779a0](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/e1779a03d80d396d0109db1fa4ee1ffbd87af15d))
+* **api:** renaming create_bulk_v2 to be more accurate ([39f088f](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/39f088fa884da126cb15988831c3ce9c464a59c2))
+* **api:** testing transforms ([2a2c279](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/2a2c27996ca393e487effe042885fda39f3fe4ee))
+* **api:** update via SDK Studio ([0c46016](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/0c4601684c4954896bdda1c9f3d21f04e41633dd))
+* **api:** update via SDK Studio ([680e2b1](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/680e2b14f4d85437cf65fedf54a79de158f63c78))
+* **api:** updates to naming convention for filedrop ([d777d9b](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/d777d9bbf4f6263a0760eef934a4f42ac9c58753))
+
+
+### Bug Fixes
+
+* **api:** added security scheme ([030c946](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/030c94617656d6b752da199cb72921fb2ec9e457))
+* improve names for conflicting params ([bf55657](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/bf55657ea1fad8b7b6d1252f27ca92c5c41059de))
+* **perf:** optimize some hot paths ([c460c2f](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/c460c2fbf27065310ae20d7ff8f695cd346487cf))
+* **perf:** skip traversing types for NotGiven values ([23d0315](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/23d031502af76e2a6c887ba6c2f7d9dd0efbb85e))
+
+
+### Chores
+
+* **client:** minor internal fixes ([1e18afb](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/1e18afbe1c9fc802920c35c830694254e2d0edfe))
+* **docs:** update client docstring ([79b746e](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/79b746e647bde40b02c6598fa938bacca1ca184d))
+* go live ([720a490](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/720a49075d217ce05708ca1432e2400243a4775a))
+* **internal:** base client updates ([762a3f8](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/762a3f84396cf8af0f3d614ef496c80602a15dd4))
+* **internal:** bump pyright version ([3b1f3be](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/3b1f3bea042dbd5c5ad63d32cc44d33e521a7115))
+* **internal:** change default timeout to an int ([18c48bc](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/18c48bc464ff765ea9de5854f906b203af0eee90))
+* **internal:** codegen related update ([6614cd8](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/6614cd8e9bc7cdbfe4e710d0b5edb3268e8ab497))
+* **internal:** codegen related update ([b406f88](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/b406f884c9c3f16aa034ce28afa836ec5194b232))
+* **internal:** codegen related update ([682619a](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/682619ad2fd07aa37ad5c2956079cdb71bbdd89a))
+* **internal:** codegen related update ([38d5f3c](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/38d5f3c0d4fdafa3306e802def490e24b86d887d))
+* **internal:** codegen related update ([f891cf0](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/f891cf09fc9664baa10d3974cba7e23e109e7384))
+* **internal:** codegen related update ([136a597](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/136a59705cc835ad815772b87b6a84783cd29be4))
+* **internal:** codegen related update ([13cae24](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/13cae24a2964cb7df668afba9ad56187869be13e))
+* **internal:** codegen related update ([dc2ccc3](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/dc2ccc345ec2c233314804c27c081906a1007b15))
+* **internal:** codegen related update ([923ad87](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/923ad878f35a79e666c87d87ed69d81d24106ea4))
+* **internal:** codegen related update ([acebb99](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/acebb990a78c56ceae409c6eae1e74ec5be38203))
+* **internal:** expand CI branch coverage ([04d0b72](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/04d0b72e5dfe37effae4c9a583874240bbfc5a77))
+* **internal:** reduce CI branch coverage ([7e361c2](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/7e361c2d575e41a4593829a2dd239964c21d645b))
+* **internal:** remove unused http client options forwarding ([34699b5](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/34699b5445c109ee1fbaee024619cfd706aad8a8))
+* **internal:** slight transform perf improvement ([64c3163](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/64c3163dacfb67764f345d48f8d13b0ad5d893d0))
+* **internal:** update pyright settings ([4962410](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/4962410963eb9c7f82444c9d10bb2d22430c8de5))
+* **tests:** improve enum examples ([2d36766](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/2d367666c2e7d1e7662ce57fb74092320b34293d))
+* update SDK settings ([8d24afa](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/8d24afaec604f18957de1d1aca9db56825588dc8))
+
+
+### Documentation
+
+* remove private imports from datetime snippets ([1e91c09](https://github.com/rsivilli-bluestaq/udl-python-sdk/commit/1e91c09e5209f8ac407574a37e9fcb2e975cc8f1))

udl_sdk-0.1.0a1/CONTRIBUTING.md

@@ -0,0 +1,129 @@
+## Setting up the environment
+
+### With Rye
+
+We use [Rye](https://rye.astral.sh/) to manage dependencies because it will automatically provision a Python environment with the expected Python version. To set it up, run:
+
+```sh
+$ ./scripts/bootstrap
+```
+
+Or [install Rye manually](https://rye.astral.sh/guide/installation/) and run:
+
+```sh
+$ rye sync --all-features
+```
+
+You can then run scripts using `rye run python script.py` or by activating the virtual environment:
+
+```sh
+$ rye shell
+# or manually activate - https://docs.python.org/3/library/venv.html#how-venvs-work
+$ source .venv/bin/activate
+
+# now you can omit the `rye run` prefix
+$ python script.py
+```
+
+### Without Rye
+
+Alternatively if you don't want to install `Rye`, you can stick with the standard `pip` setup by ensuring you have the Python version specified in `.python-version`, create a virtual environment however you desire and then install dependencies using this command:
+
+```sh
+$ pip install -r requirements-dev.lock
+```
+
+## Modifying/Adding code
+
+Most of the SDK is generated code. Modifications to code will be persisted between generations, but may
+result in merge conflicts between manual patches and changes from the generator. The generator will never
+modify the contents of the `src/unifieddatalibrary/lib/` and `examples/` directories.
+
+## Adding and running examples
+
+All files in the `examples/` directory are not modified by the generator and can be freely edited or added to.
+
+```py
+# add an example to examples/<your-example>.py
+
+#!/usr/bin/env -S rye run python
+…
+```
+
+```sh
+$ chmod +x examples/<your-example>.py
+# run the example against your api
+$ ./examples/<your-example>.py
+```
+
+## Using the repository from source
+
+If you’d like to use the repository from source, you can either install from git or link to a cloned repository:
+
+To install via git:
+
+```sh
+$ pip install git+ssh://git@github.com/rsivilli-bluestaq/udl-python-sdk.git
+```
+
+Alternatively, you can build from source and install the wheel file:
+
+Building this package will create two files in the `dist/` directory, a `.tar.gz` containing the source files and a `.whl` that can be used to install the package efficiently.
+
+To create a distributable version of the library, all you have to do is run this command:
+
+```sh
+$ rye build
+# or
+$ python -m build
+```
+
+Then to install:
+
+```sh
+$ pip install ./path-to-wheel-file.whl
+```
+
+## Running tests
+
+Most tests require you to [set up a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests.
+
+```sh
+# you will need npm installed
+$ npx prism mock path/to/your/openapi.yml
+```
+
+```sh
+$ ./scripts/test
+```
+
+## Linting and formatting
+
+This repository uses [ruff](https://github.com/astral-sh/ruff) and
+[black](https://github.com/psf/black) to format the code in the repository.
+
+To lint:
+
+```sh
+$ ./scripts/lint
+```
+
+To format and fix all ruff issues automatically:
+
+```sh
+$ ./scripts/format
+```
+
+## Publishing and releases
+
+Changes made to this repository via the automated release PR pipeline should publish to PyPI automatically. If
+the changes aren't made through the automated pipeline, you may want to make releases manually.
+
+### Publish with a GitHub workflow
+
+You can release to package managers by using [the `Publish PyPI` GitHub action](https://www.github.com/rsivilli-bluestaq/udl-python-sdk/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up.
+
+### Publish manually
+
+If you need to manually release a package, you can run the `bin/publish-pypi` script with a `PYPI_TOKEN` set on
+the environment.

udl_sdk-0.1.0a1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Unifieddatalibrary
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.