python-openarch-api 0.1.0__tar.gz

python_openarch_api-0.1.0/.gitignore

@@ -0,0 +1,5 @@
+venv*/
+__pycache__/
+*.egg-info/
+dist/
+.pytest_cache/

python_openarch_api-0.1.0/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+## [2026-10-22] - v0.1.0 : Initial version
+
+- First version: sync and async clients for every operation of the OpenArch REST API (`docs/openapi/openarch-api.yaml`, 12.0-SNAPSHOT, generated from OpenArch `main` `aa90475b`), Pydantic v2 models generated with datamodel-code-generator, hand-written OpenArchDocument / OpenArchQueryResult for the dynamic cin_* properties, Basic / bearer / custom auth.
+- Started as python-hxpr-api against content-lake-app's `hxpr-api.yaml`; renamed when hxpr was published as OpenArch. Against that spec: renditions, bulk import and feature flags are gone; v2 model and security-policy methods (optimistic locking), conditional writes (`if_`), `upsert`, `user_change`, query `syntax` / `search_after` / `sync`, typed terms aggregation results, and `RepositoryErrorResponse` (was `HxprErrorResponse`) are new.
+- Spec refreshed from OpenArch `main` `34caff31` (2026-10-19): only the new `BasicAuth` security scheme (Basic was already supported, `username` / `password`); operations, schemas and generated models unchanged. Unit and live tests pass against it.
+- Checked against OpenArch `main` `28f4b833` (2026-10-21): spec identical; unit and live tests pass.
+- `py.typed` marker (PEP 561), so type checkers use the package's type hints.
+- Tested against a live OpenArch (`tests/test_live.py`, opt-in with `OPENARCH_URL`). From that: `OpenArchConflictError` (409, stale v2 `version`) and `OpenArchPreconditionError` (412, failed `condition` / `if_`); typed `TermsBucket` (`key`, `doc_count`), since the spec's `StringTermsBucket` is empty; the multipart part convention (`uploadId` references) documented.

python_openarch_api-0.1.0/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 [yyyy] [name of copyright owner]
+
+   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.

python_openarch_api-0.1.0/PKG-INFO

@@ -0,0 +1,260 @@
+Metadata-Version: 2.5
+Name: python-openarch-api
+Version: 0.1.0
+Summary: Python client for the Hyland OpenArch repository REST API, with Pydantic v2 models
+Project-URL: Homepage, https://github.com/stevereiner/python-openarch-api
+Project-URL: Repository, https://github.com/stevereiner/python-openarch-api
+Project-URL: Issues, https://github.com/stevereiner/python-openarch-api/issues
+Project-URL: Documentation, https://github.com/stevereiner/python-openarch-api/blob/main/docs/api.md
+Author: Steve Reiner
+License: Apache-2.0
+License-File: LICENSE
+Keywords: content-lake,hxpr,hyland,nuxeo,openarch,pydantic,rest-api
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.7
+Provides-Extra: dev
+Requires-Dist: datamodel-code-generator[black,isort]==0.83.0; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: pyyaml>=6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# python-openarch-api
+
+Python client for the REST API of [Hyland OpenArch](https://github.com/Hyland/OpenArch), an open
+source project that federates unstructured, AI-ready data from all sources across an organization
+and makes it available to AI services and agents while always respecting permissions. OpenArch can
+be self-managed and used with your own LLMs and choice of AI services. Sync and async, with
+Pydantic v2 models.
+
+- **Every operation** of `docs/openapi/openarch-api.yaml`: documents by id and path (with
+  conditional writes and upsert), query / advanced / named / terms aggregation / vector search,
+  download, users and groups, repository model and security policies (v1 and v2), vocabularies,
+  upload.
+- **Pydantic v2 models** generated from the spec, plus hand-written `OpenArchDocument` and
+  `OpenArchQueryResult`: documents carry dynamic `cin_*` properties the generated types do not
+  type (the same choice content-lake-app makes in Java).
+- **`OpenArchClient`** (sync) and **`AsyncOpenArchClient`** (async), on httpx. The sync client is
+  generated from the async one, so the two never drift.
+- Basic auth (a local OpenArch), bearer token (the cloud CIC) — a string or a function returning
+  the current one — or any `httpx.Auth`.
+
+Status: alpha (0.1.0). Written against the spec generated by running OpenArch
+(`docs/openapi/openarch-api.yaml`), first from `main` `aa90475b` (2026-10-13, 12.0-SNAPSHOT). The
+spec was regenerated from `main` `34caff31` (2026-10-19), the version that added the `BasicAuth`
+security scheme, its only change: until then the spec declared only the bearer token of the cloud
+CIC (Hyland Content Innovation Cloud). Checked again on 2026-10-21 against `28f4b833` (unchanged);
+see [docs/openapi/README.md](docs/openapi/README.md). Unit-tested with mocks and tested against a
+local OpenArch in Docker (`tests/test_live.py`).
+
+## Install
+
+```bash
+uv pip install python-openarch-api
+```
+
+For development with the source, install from a clone instead: `uv pip install -e ".[dev]"` (see
+[Development](#development)).
+
+## Use
+
+Every method, model and error is described in the API reference, [docs/api.md](docs/api.md).
+
+```python
+from python_openarch_api import OpenArchClient, OpenArchDocument
+
+with OpenArchClient("http://localhost:8080", username="admin", password="password") as oa:
+    print(oa.hello(protected=True))
+
+    # Query (HXQL)
+    result = oa.query("SELECT * FROM SysContent WHERE cin_sourceId = 'repo-1'", limit=50)
+    for doc in result.documents:
+        print(doc.sys_id, doc.sys_name, doc.cin_id, doc.properties)
+
+    # Next page: pass the cursor back
+    more = oa.query("SELECT * FROM SysContent WHERE cin_sourceId = 'repo-1'", limit=50,
+                    search_after=result.next_search_after)
+
+    # Create a document carrying source-system fields (needs the CinRemote mixin)
+    doc = OpenArchDocument(sys_primary_type="SysFile", sys_name="report.pdf",
+                           cin_id="node-1", cin_source_id="repo-1").with_cin_remote()
+    created = oa.create_document_by_path("/alfresco-sync", doc)
+
+    # Partial update, only if the title is still the old one
+    oa.patch_document(created.sys_id, [{"op": "replace", "path": "/sys_title", "value": "Report"}],
+                      if_='content.sys_title == "report.pdf"')
+```
+
+Async:
+
+```python
+from python_openarch_api import AsyncOpenArchClient
+
+async with AsyncOpenArchClient("https://openarch.example.com", token=get_access_token) as oa:
+    doc = await oa.get_document("a1b2c3")
+```
+
+### Documents and dynamic properties
+
+`OpenArchDocument` has the schema's `sys_*` fields (snake_case in Python, e.g.
+`sys_primary_type`; their wire names on the way out) and the `CinRemote` fields `cin_id`,
+`cin_source_id`, `cin_paths`, `cin_ingest_properties`, `cin_ingest_property_names`, `cin_read`,
+`cin_deny`. Any other property (repository-model fields, `sysembed_*`) is kept as is:
+
+```python
+doc.properties               # {"my_customField": 42, ...}  (wire names)
+doc.get("cin_sourceId")      # any property by wire name
+doc.to_json()                # request body: wire names, None left out
+```
+
+OpenArch rejects a document with `cin_*` fields unless `sys_mixinTypes` includes `CinRemote`;
+`with_cin_remote()` adds it.
+
+### Binary content
+
+A blob property points at its content by `uploadId`. Send the content in the same request (the
+part name is yours to pick), or upload it first:
+
+```python
+oa.create_document_by_path("/docs", {"sys_primaryType": "SysFile", "sys_name": "a.txt",
+                                     "sysfile_blob": {"uploadId": "f1"}},
+                           files={"f1": ("a.txt", data, "text/plain")})
+
+up = oa.upload(data, file_name="a.txt", mime_type="text/plain")
+oa.create_document_by_path("/docs", {"sys_primaryType": "SysFile", "sys_name": "a.txt",
+                                     "sysfile_blob": {"uploadId": up.id}})
+
+oa.download(doc_id, "sysfile_blob/a.txt")    # -> bytes
+```
+
+### Writes
+
+`update_document`, `patch_document`, `move` (and the `_by_path` ones) take `condition=` (an HXQL
+predicate) or `if_=` (an expression), `user_change=False` for technical updates that should not
+bump `sys_ugen`, and on PUT `upsert=True` to create the document when it does not exist.
+
+### Model and security policies: v1 and v2
+
+`get_model` / `set_model` / `get_security_policies` / `set_security_policies` are the v1 API. The
+`_v2` methods return and take a `version` for optimistic locking: read with `get_*_v2`, change,
+and send the same object back with `set_*_v2`.
+
+### Repository
+
+The `HXCS-REPOSITORY` header is sent on every request (`repository="default"`); pass
+`repository=` to the client or to a call to use another one.
+
+### Errors
+
+Non-2xx answers raise `OpenArchError` (`status_code`, `error` = the parsed
+`RepositoryErrorResponse`), or its subclasses `OpenArchAuthError` (401/403),
+`OpenArchNotFoundError` (404), `OpenArchConflictError` (409: a `set_*_v2` with a stale `version`)
+and `OpenArchPreconditionError` (412: a `condition` / `if_` that did not match, or checkin of a
+non-versionable document).
+
+## Development
+
+Create and activate a virtual environment, then install the package with the `dev` extra.
+
+Linux / macOS:
+
+```bash
+uv venv venv-3.14 --python 3.14
+source venv-3.14/bin/activate
+uv pip install -e ".[dev]"
+python -m pytest
+```
+
+Windows (PowerShell or Command Prompt):
+
+```powershell
+uv venv venv-3.14 --python 3.14
+venv-3.14\Scripts\activate
+uv pip install -e ".[dev]"
+python -m pytest
+```
+
+With the virtual environment active, the same on every platform:
+
+```bash
+python scripts/generate_models.py   # after updating docs/openapi/openarch-api.yaml
+python scripts/unasync.py           # after editing python_openarch_api/_async/client.py
+```
+
+The `dev` extra (`-e ".[dev]"`) is needed to run the tests and the scripts: it brings pytest,
+PyYAML (a test reads the spec) and the pinned datamodel-code-generator. A plain
+`uv pip install -e .` installs only httpx and Pydantic.
+
+- `docs/openapi/openarch-api.yaml` — the spec, downloaded from a running OpenArch (it ships no
+  static spec); [docs/openapi/README.md](docs/openapi/README.md) says how to regenerate it.
+- `python_openarch_api/models/generated.py` — generated by datamodel-code-generator (pinned); do
+  not edit.
+- `python_openarch_api/_async/client.py` — the client; edit this one.
+- `python_openarch_api/_sync/client.py` — generated from it; a test fails if it is stale.
+- A test checks that every `operationId` in the spec has a client method.
+- `tests/test_live.py` runs against a real OpenArch when `OPENARCH_URL` is set (it creates and
+  deletes a folder at the root). OpenArch's root `docker-compose.yml` leaves the data dir
+  unwritable, so every upload is a 500: start `openarch-app` with `NUXEO_DATA_DIR=/tmp`, as
+  OpenArch's own README and CI do.
+
+### Tests
+
+`pytest` collects 23 tests in total: 16 unit tests (`tests/test_client.py`, with mocks, no server)
+and 7 live tests (`tests/test_live.py`), which are skipped unless `OPENARCH_URL` is set. To run the
+live tests against a running OpenArch, set `OPENARCH_URL` in the shell where the virtual
+environment is active. Use `http://localhost:8080` for OpenArch's own default port, or
+`http://localhost:8088` for the OpenArch of KG Spaces Deployment (its `OPENARCH_PORT`, 8088 by
+default).
+
+Linux / macOS:
+
+```bash
+OPENARCH_URL=http://localhost:8080 python -m pytest tests/test_live.py
+```
+
+Windows (PowerShell):
+
+```powershell
+$env:OPENARCH_URL = "http://localhost:8080"
+python -m pytest tests/test_live.py
+```
+
+Windows (Command Prompt):
+
+```bat
+set OPENARCH_URL=http://localhost:8080
+python -m pytest tests/test_live.py
+```
+
+Without `tests/test_live.py`, `python -m pytest` runs the unit tests and the live tests together.
+
+`OPENARCH_USER` / `OPENARCH_PASSWORD` set the Basic auth user; they default to the admin user of
+the local `openarch-app`'s `openarch-users.yml`. Set them the same way as `OPENARCH_URL`.
+
+## Where the spec and the server differ
+
+The client follows the server where the generated spec is short of it:
+
+- Multipart document writes: the spec shows a placeholder part (`main1234`); any name works, as
+  long as a blob property references it by `uploadId`.
+- `nextSearchAfter`: the query schemas refer to it but `QueryResult` does not declare it;
+  `OpenArchQueryResult.next_search_after` reads it.
+- `StringTermsBucket` has no properties in the spec; `TermsBucket` types `key` and `doc_count`.
+- Responses the spec leaves untyped (named query list, v1 security policies) are returned as
+  parsed JSON.
+- `download_url` needs a blob provider with pre-signed URLs (S3); the local filesystem store
+  answers 501.
+
+## License
+
+Apache-2.0, as is OpenArch, from which `docs/openapi/openarch-api.yaml` is generated.