luxir-client 0.1.0__tar.gz

luxir_client-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.

luxir_client-0.1.0/PKG-INFO

@@ -0,0 +1,321 @@
+Metadata-Version: 2.4
+Name: luxir-client
+Version: 0.1.0
+Summary: Python client for the Luxir search engine (https://luxir.org/)
+Author: moonlitesolutions
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/moonlitesolutions/LuxirClient
+Project-URL: Repository, https://github.com/moonlitesolutions/LuxirClient
+Project-URL: Issues, https://github.com/moonlitesolutions/LuxirClient/issues
+Project-URL: Luxir Search Engine, https://luxir.org/
+Keywords: luxir,search,search-engine,client
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+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
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database :: Front-Ends
+Classifier: Topic :: Text Processing :: Indexing
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.20
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
+Dynamic: license-file
+
+# LuxirClient
+
+A lightweight Python client for [Luxir](https://luxir.org/), a hybrid
+search engine (BM25 + vector + facets, all in one request). This client
+talks to Luxir's HTTP API.
+
+- [Installation](#installation)
+- [Quickstart](#quickstart)
+- [Concepts](#concepts)
+- [Guide](#guide)
+  - [Connecting](#connecting)
+  - [Collections](#collections)
+  - [Schema](#schema)
+  - [Indexing](#indexing)
+  - [Searching](#searching)
+  - [Faceting](#faceting)
+  - [Fetching a single document](#fetching-a-single-document)
+  - [Deleting](#deleting)
+  - [Stats and health](#stats-and-health)
+- [Error handling](#error-handling)
+- [Gotchas](#gotchas)
+- [What's not here yet](#whats-not-here-yet)
+- [Development](#development)
+
+## Installation
+
+This isn't published to PyPI yet — install it from a local checkout:
+
+```bash
+pip install -e /path/to/LuxirClient
+```
+
+It depends only on `requests`.
+
+## Quickstart
+
+```python
+from luxir_client import LuxirClient
+
+client = LuxirClient("http://localhost:9400")
+
+# Collections auto-create on first write — no setup step required.
+client.index("books", [
+    {"id": "b1", "title_t": "Dune", "year_i": 1965},
+    {"id": "b2", "title_t": "Dune Messiah", "year_i": 1969},
+])
+
+res = client.search("books", {
+    "query": "title_t:dune",
+    "get_number": True,
+    "get_scores": True,
+})
+print(res.get_num_found())   # 2
+print(res.get_docs())        # [{'id': 'b1', ...}, {'id': 'b2', ...}]
+```
+
+## Concepts
+
+A few Luxir ideas that shape how you'll use this client:
+
+- **Collections auto-create.** There's no required "create collection"
+  step — the first `index()` call into a new name creates it. Use
+  `client.collections.create(...)` only when you want to install a
+  schema *before* any documents land.
+- **Field names carry their type.** Luxir infers a field's type from a
+  naming suffix instead of requiring an upfront schema:
+
+  | Suffix | Meaning |
+  |---|---|
+  | `_t` | full-text, stemmed/analyzed |
+  | `_s` | exact-match string |
+  | `_i` / `_is` | int, single or multi-valued |
+  | `_f` / `_fs` | float |
+  | `_dt` | date |
+  | `_v` | vector |
+  | `_name` | text with folding, no stemming |
+
+  So `{"id": "b1", "title_t": "Dune", "year_i": 1965}` is enough — no
+  schema declaration needed. Declare one later with `client.schema` if
+  you want tighter control.
+- **Queries are either strings or structured dicts.** `"query":
+  "title_t:dune AND year_i:>=1960"` and `"query": {"match": {"field":
+  "title_t", "val": "dune"}}` are both valid — this client just passes
+  whatever you give it straight through as JSON.
+- **Facets and metrics live under `ops`, not a separate facet param.**
+  Search, facets, and analytics all execute in a single request.
+
+## Guide
+
+### Connecting
+
+```python
+client = LuxirClient("http://localhost:9400")
+```
+
+Pass a list of hosts to get automatic failover to the next host if one
+is unreachable:
+
+```python
+client = LuxirClient(["http://search-a:9400", "http://search-b:9400"])
+```
+
+### Collections
+
+```python
+client.collections.list()                 # ['books', 'main']
+client.collections.exists("books")         # True
+client.collections.create("reviews")       # explicit create, no schema
+client.collections.create("reviews", schema={...})  # create with a schema
+client.collections.delete("reviews")
+client.collections.stats("books")          # per-collection stats
+client.collections.stats("books", segments=True)
+```
+
+### Schema
+
+```python
+client.schema.get("books")                  # authored schema
+client.schema.get("books", resolved=True)   # expanded/physical view
+client.schema.set_fields("books", {
+    "title": {"type": "text", "stored": True},
+})
+client.schema.replace_all("books", {"fields": {...}})
+client.schema.does_field_exist("books", "title_t")
+```
+
+### Indexing
+
+```python
+# Convenience wrapper — commits by default.
+client.index("books", [
+    {"id": "b1", "title_t": "Dune", "year_i": 1965},
+])
+
+# Index without committing immediately (visibility delayed).
+client.index("books", docs, commit=False)
+
+# Full control via update(): mix upserts and deletes in one request.
+client.update("books",
+    docs=[{"id": "b3", "title_t": "Children of Dune"}],
+    delete_ids=["b1"],
+    commit={},
+)
+```
+
+### Searching
+
+```python
+res = client.search("books", {
+    "query": "title_t:(dune OR messiah) AND year_i:>=1965",
+    "filter": ["stock_i:>0"],       # non-scoring, ANDed with query
+    "limit": 10,
+    "get_number": True,             # populates res.get_num_found()
+    "get_scores": True,             # populates res.get_scores()
+    "fields": ["id", "title_t", "year_i"],
+})
+
+res.get_docs()          # list of doc dicts
+res.get_results_count() # len(docs) in this response
+res.get_num_found()     # exact total match count (needs get_number=True)
+res.get_scores()        # {doc_id: score} (needs get_scores=True)
+res.get_json()          # raw response as a JSON string
+```
+
+Omit `"query"` entirely to match every document (useful for
+count-only or facet-only requests with `"limit": 0`).
+
+`search_raw()` returns the plain parsed dict instead of a
+`LuxirResponse`, if you'd rather work with it directly.
+
+### Faceting
+
+Facets are requested under `ops` and read back the same way:
+
+```python
+res = client.search("books", {
+    "limit": 0,  # don't need docs, just the facet
+    "ops": {
+        "by_genre": {"field_facet": {"field": "genre_s"}},
+    },
+})
+res.get_facet_buckets("by_genre")
+# [{'val': 'scifi', 'count': 2}, {'val': 'romance', 'count': 1}]
+
+res.get_ops()             # the whole `ops` block
+res.get_ops("by_genre")   # just this op's result
+```
+
+Range facets, date histograms, and per-bucket metrics (`avg`, `min`,
+...) all go through the same `ops` mechanism — see [Luxir's faceting
+docs](https://luxir.org/docs/latest/guide/faceting/) for the full
+request shapes. This client doesn't wrap them individually; pass
+whatever `ops` dict you need.
+
+### Fetching a single document
+
+```python
+doc = client.get("books", "b1")   # raises NotFoundError if missing
+```
+
+Luxir has no dedicated realtime-get endpoint, so this is sugar over a
+`search()` filtered to that id — not a separate, cheaper code path.
+
+### Deleting
+
+```python
+client.delete_by_id("books", "b1")             # single id
+client.delete_by_id("books", ["b1", "b2"])      # multiple ids
+client.delete_by_id("books", "b1", commit=False)
+```
+
+There's no `delete_by_query` — Luxir doesn't implement one.
+
+### Stats and health
+
+```python
+client.health()             # {'status': 'ok'}
+client.stats()               # node-wide stats
+client.stats("books")        # per-collection stats
+```
+
+## Error handling
+
+Every failure — whether the server returned an HTTP error status or a
+200 with an error embedded in the body (Luxir does both, depending on
+the endpoint) — raises a typed exception from `luxir_client.exceptions`,
+all inheriting from `LuxirError`:
+
+```python
+from luxir_client.exceptions import NotFoundError, AlreadyExistsError
+
+try:
+    client.search("does_not_exist", {})
+except NotFoundError as e:
+    print(e.kind, e.code, e.message)
+    # not_found collection_not_found "collection 'does_not_exist' does not exist"
+```
+
+| Exception | Luxir `kind` | Typical cause |
+|---|---|---|
+| `InvalidRequestError` | `invalid_request` | Malformed query/payload |
+| `NotFoundError` | `not_found` | Missing collection/document |
+| `AlreadyExistsError` | `already_exists` | Duplicate collection create |
+| `FailedPreconditionError` | `failed_precondition` | State conflict |
+| `ResourceExhaustedError` | `resource_exhausted` | Rate-limited (HTTP 429) — safe to retry with backoff |
+| `UnavailableError` | `unavailable` | Server temporarily unavailable — safe to retry |
+| `InternalError` | `internal` | Server-side bug |
+| `ConnectionError` | — | Couldn't reach any configured host at all |
+
+An unrecognized `kind` still raises, as the base `LuxirError`, so new
+server-side error kinds fail loudly instead of silently.
+
+## Gotchas
+
+Things confirmed by hand against a live instance that are easy to trip
+over:
+
+- **`"query": "*"` is not match-all.** Omit the `query` key entirely to
+  match everything. A bare `*` raises `InvalidRequestError` (unfielded
+  term).
+- **Search errors can come back as HTTP 200.** The error envelope
+  (`{"error": {...}}`) can be embedded in a 200 response body just as
+  often as a 4xx/5xx status — this client checks for the `error` key
+  before looking at the status code, so you don't need to handle this
+  yourself, but don't assume `response.status_code == 200` means
+  success if you're bypassing the client.
+- **`collections.list()`'s response key (`collections`) isn't
+  documented**, just inferred from behavior — flag it if a future
+  Luxir version changes the field name.
+
+## What's not here yet
+
+This is deliberately a lightweight first cut. Not implemented, add as
+needed:
+
+- gRPC transport (`luxir.Indexer`/`luxir.Searcher`/`luxir.Admin`)
+- NDJSON bulk streaming for indexing (currently one bounded JSON
+  request per `update()`/`index()` call)
+- A structured query-builder helper (`Q.match(...)`, `Q.boolean(...)`, etc.)
+- kind-aware retry/backoff (currently: no automatic retries at all,
+  other than failing over to the next host on connection errors)
+- An async client
+
+## Development
+
+```bash
+pip install -e ".[test]"
+pytest
+```
+
+Tests run against a mocked `requests.Session` — no live Luxir instance
+required.