legiscore 0.1.0__tar.gz

legiscore-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+# Build output
+build/
+dist/
+*.egg-info/
+
+# Caches
+__pycache__/
+*.pyc
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/

legiscore-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 2026 LawyerDesk Advocacy Pvt Ltd
+
+   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.

legiscore-0.1.0/PKG-INFO

@@ -0,0 +1,204 @@
+Metadata-Version: 2.5
+Name: legiscore
+Version: 0.1.0
+Summary: Python SDK for the LegiScore partner API — title search and legal opinion reports.
+Project-URL: Homepage, https://legiscore.in
+Project-URL: Documentation, https://github.com/lawyerdeskai/legiscore-sdk#readme
+Project-URL: Repository, https://github.com/lawyerdeskai/legiscore-sdk
+Project-URL: Issues, https://github.com/lawyerdeskai/legiscore-sdk/issues
+Project-URL: Changelog, https://github.com/lawyerdeskai/legiscore-sdk/releases
+Author-email: LawyerDesk Advocacy Pvt Ltd <info@legiscore.in>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: due-diligence,india,legal-opinion,legiscore,property,title-search
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Intended Audience :: Legal Industry
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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 :: Office/Business :: Financial
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx<1,>=0.27
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: twine; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# legiscore
+
+Python SDK for the [LegiScore](https://legiscore.in) partner API — title search and legal
+opinion reports on Indian property.
+
+- **Python 3.10+**, one dependency (`httpx`)
+- **Sync and async**, same method names on both clients
+- **Typed**: ships a `py.typed` marker, so mypy and pyright see every annotation
+- **Webhook verification built in**, because that is the step integrations get wrong
+
+```bash
+pip install legiscore
+```
+
+## Quickstart
+
+<table>
+<tr><th>Sync</th><th>Async</th></tr>
+<tr valign="top"><td>
+
+```python
+from legiscore import LegiScore
+
+with LegiScore(api_key="lsk_...") as client:
+    case = client.create_report(
+        property_focus="Sy. No. 123, Example Village, Telangana",
+        files=["sale-deed.pdf", "ec.pdf"],
+    )
+    status = client.wait_for_case(case["case_id"])
+
+    if status["state"] == "completed":
+        report = client.reports.get_case_result(case["case_id"])
+```
+
+</td><td>
+
+```python
+from legiscore import AsyncLegiScore
+
+async with AsyncLegiScore(api_key="lsk_...") as client:
+    case = await client.create_report(
+        property_focus="Sy. No. 123, Example Village, Telangana",
+        files=["sale-deed.pdf", "ec.pdf"],
+    )
+    status = await client.wait_for_case(case["case_id"])
+
+    if status["state"] == "completed":
+        report = await client.reports.get_case_result(case["case_id"])
+```
+
+</td></tr>
+</table>
+
+Set `LEGISCORE_API_KEY` in the environment and you can drop the `api_key=` argument entirely.
+
+A case can pause and wait for you. `awaiting_review` means it needs missing documents, a document
+review, or risk acknowledgements before it can finish, and each pause has a matching resume
+method:
+
+```python
+if status["state"] == "awaiting_review":
+    missing = client.reports.get_missing_documents(case["case_id"])
+    client.reports.continue_case(case["case_id"], body={"new_document_ids": [...]})
+```
+
+`examples/end_to_end.py` in the repository walks one report through every pause.
+
+## The six modules
+
+Endpoints are grouped by module, on both clients:
+
+| Namespace | What it covers |
+|---|---|
+| `client.core` | Credits, scenarios, custom field configs, document uploads |
+| `client.reports` | Cases: create, status, result, files, and every pause/resume step |
+| `client.search` | Raw searches over the state portals, plus the state and lookup catalogues |
+| `client.translate` | Document translation sessions |
+| `client.extraction` | Property extraction from a document |
+| `client.webhooks` | List, create, update, delete and rotate the secret on your webhooks |
+
+The client itself adds the multi-step helpers: `create_report`, `upload_document`,
+`wait_for_case` and `check_connection`.
+
+## Concurrency
+
+`LegiScore` holds one connection pool and is safe to share across threads. `AsyncLegiScore` holds
+one pool per event loop and is safe to share across tasks. Use either as a context manager, or
+call `client.close()` / `await client.aclose()` when you are finished, so the pool is released.
+
+## Errors and retries
+
+Failures raise `LegiScoreError`, which carries `.status_code` and `.body`.
+
+> `error.body` is the API's reply verbatim and may contain customer data — names, identifiers,
+> document text. Log `error.status_code` and `str(error)`, which carry neither customer data nor
+> your API key; do not log `.body` raw.
+
+Retries are conservative on purpose, because a repeated write can spend credits twice:
+
+| Call | Replayed on |
+|---|---|
+| Reads (`GET`) | 429, 502, 503, 504 |
+| Writes that carry an `Idempotency-Key` (creating a case, completing an upload) | 429, 502, 503, 504 |
+| Every other write | **429 only** — any other failure may mean the work was done and only the reply was lost |
+| `rotate-secret` | never — a rotation returns the new secret exactly once |
+| Presigned storage uploads | 429, 502, 503, 504 |
+
+Backoff is exponential with jitter, honours `Retry-After` in both its seconds and HTTP-date forms,
+and never waits more than a minute between attempts. Three retries is the default; change it with
+`LegiScore(max_retries=...)`.
+
+`base_url` must be `https://` (or `http://localhost` for local development) — the API key travels
+in a header and the SDK refuses to send it unencrypted.
+
+## Verifying webhooks
+
+```python
+from fastapi import FastAPI, Request, Response
+from legiscore import InvalidSignature, verify_webhook
+
+app = FastAPI()
+
+
+@app.post("/webhooks/legiscore")
+async def receive(request: Request) -> Response:
+    try:
+        event = verify_webhook(
+            await request.body(),  # RAW bytes, not the parsed JSON
+            request.headers,
+            secret=WEBHOOK_SECRET,
+        )
+    except InvalidSignature:
+        return Response(status_code=400)
+
+    if event.is_pause:
+        handle_pause(event.case_id)
+    return Response(status_code=204)
+```
+
+`body` must be the **raw request bytes**. Re-serialising parsed JSON changes the byte string and
+the signature check then fails — this is the single most common integration bug. Deliveries older
+than five minutes are rejected as replays, and an empty secret fails closed rather than trusting
+the delivery. Deliveries can repeat, so key your own processing on `event.delivery_id`.
+
+**Setting the webhook up.** Create it in the LegiScore dashboard with auth type **HMAC**. The secret
+it shows you is `WEBHOOK_SECRET`; there is no other place to get it, and a webhook created with any
+other auth type sends no `X-LegiScore-Signature` at all, so verification will reject every delivery.
+
+**Leave "Allowed domains" empty on a server-side key.** A non-empty list is checked against the
+`Origin` or `Referer` header, which a server-to-server call does not send, so every request returns
+403 no matter how valid the key is.
+
+## Checking the connection
+
+```python
+report = client.check_connection()  # returns a dict, never raises
+if not report["ok"]:
+    raise SystemExit(report["problem"])
+```
+
+## Dependencies
+
+The only runtime dependency is `httpx>=0.27,<1`. If you pin your own transitive dependencies, keep
+`h11>=0.16` — older releases carry a request-smuggling advisory, and a fresh install picks a safe
+version on its own.

legiscore-0.1.0/README.md

@@ -0,0 +1,165 @@
+# legiscore
+
+Python SDK for the [LegiScore](https://legiscore.in) partner API — title search and legal
+opinion reports on Indian property.
+
+- **Python 3.10+**, one dependency (`httpx`)
+- **Sync and async**, same method names on both clients
+- **Typed**: ships a `py.typed` marker, so mypy and pyright see every annotation
+- **Webhook verification built in**, because that is the step integrations get wrong
+
+```bash
+pip install legiscore
+```
+
+## Quickstart
+
+<table>
+<tr><th>Sync</th><th>Async</th></tr>
+<tr valign="top"><td>
+
+```python
+from legiscore import LegiScore
+
+with LegiScore(api_key="lsk_...") as client:
+    case = client.create_report(
+        property_focus="Sy. No. 123, Example Village, Telangana",
+        files=["sale-deed.pdf", "ec.pdf"],
+    )
+    status = client.wait_for_case(case["case_id"])
+
+    if status["state"] == "completed":
+        report = client.reports.get_case_result(case["case_id"])
+```
+
+</td><td>
+
+```python
+from legiscore import AsyncLegiScore
+
+async with AsyncLegiScore(api_key="lsk_...") as client:
+    case = await client.create_report(
+        property_focus="Sy. No. 123, Example Village, Telangana",
+        files=["sale-deed.pdf", "ec.pdf"],
+    )
+    status = await client.wait_for_case(case["case_id"])
+
+    if status["state"] == "completed":
+        report = await client.reports.get_case_result(case["case_id"])
+```
+
+</td></tr>
+</table>
+
+Set `LEGISCORE_API_KEY` in the environment and you can drop the `api_key=` argument entirely.
+
+A case can pause and wait for you. `awaiting_review` means it needs missing documents, a document
+review, or risk acknowledgements before it can finish, and each pause has a matching resume
+method:
+
+```python
+if status["state"] == "awaiting_review":
+    missing = client.reports.get_missing_documents(case["case_id"])
+    client.reports.continue_case(case["case_id"], body={"new_document_ids": [...]})
+```
+
+`examples/end_to_end.py` in the repository walks one report through every pause.
+
+## The six modules
+
+Endpoints are grouped by module, on both clients:
+
+| Namespace | What it covers |
+|---|---|
+| `client.core` | Credits, scenarios, custom field configs, document uploads |
+| `client.reports` | Cases: create, status, result, files, and every pause/resume step |
+| `client.search` | Raw searches over the state portals, plus the state and lookup catalogues |
+| `client.translate` | Document translation sessions |
+| `client.extraction` | Property extraction from a document |
+| `client.webhooks` | List, create, update, delete and rotate the secret on your webhooks |
+
+The client itself adds the multi-step helpers: `create_report`, `upload_document`,
+`wait_for_case` and `check_connection`.
+
+## Concurrency
+
+`LegiScore` holds one connection pool and is safe to share across threads. `AsyncLegiScore` holds
+one pool per event loop and is safe to share across tasks. Use either as a context manager, or
+call `client.close()` / `await client.aclose()` when you are finished, so the pool is released.
+
+## Errors and retries
+
+Failures raise `LegiScoreError`, which carries `.status_code` and `.body`.
+
+> `error.body` is the API's reply verbatim and may contain customer data — names, identifiers,
+> document text. Log `error.status_code` and `str(error)`, which carry neither customer data nor
+> your API key; do not log `.body` raw.
+
+Retries are conservative on purpose, because a repeated write can spend credits twice:
+
+| Call | Replayed on |
+|---|---|
+| Reads (`GET`) | 429, 502, 503, 504 |
+| Writes that carry an `Idempotency-Key` (creating a case, completing an upload) | 429, 502, 503, 504 |
+| Every other write | **429 only** — any other failure may mean the work was done and only the reply was lost |
+| `rotate-secret` | never — a rotation returns the new secret exactly once |
+| Presigned storage uploads | 429, 502, 503, 504 |
+
+Backoff is exponential with jitter, honours `Retry-After` in both its seconds and HTTP-date forms,
+and never waits more than a minute between attempts. Three retries is the default; change it with
+`LegiScore(max_retries=...)`.
+
+`base_url` must be `https://` (or `http://localhost` for local development) — the API key travels
+in a header and the SDK refuses to send it unencrypted.
+
+## Verifying webhooks
+
+```python
+from fastapi import FastAPI, Request, Response
+from legiscore import InvalidSignature, verify_webhook
+
+app = FastAPI()
+
+
+@app.post("/webhooks/legiscore")
+async def receive(request: Request) -> Response:
+    try:
+        event = verify_webhook(
+            await request.body(),  # RAW bytes, not the parsed JSON
+            request.headers,
+            secret=WEBHOOK_SECRET,
+        )
+    except InvalidSignature:
+        return Response(status_code=400)
+
+    if event.is_pause:
+        handle_pause(event.case_id)
+    return Response(status_code=204)
+```
+
+`body` must be the **raw request bytes**. Re-serialising parsed JSON changes the byte string and
+the signature check then fails — this is the single most common integration bug. Deliveries older
+than five minutes are rejected as replays, and an empty secret fails closed rather than trusting
+the delivery. Deliveries can repeat, so key your own processing on `event.delivery_id`.
+
+**Setting the webhook up.** Create it in the LegiScore dashboard with auth type **HMAC**. The secret
+it shows you is `WEBHOOK_SECRET`; there is no other place to get it, and a webhook created with any
+other auth type sends no `X-LegiScore-Signature` at all, so verification will reject every delivery.
+
+**Leave "Allowed domains" empty on a server-side key.** A non-empty list is checked against the
+`Origin` or `Referer` header, which a server-to-server call does not send, so every request returns
+403 no matter how valid the key is.
+
+## Checking the connection
+
+```python
+report = client.check_connection()  # returns a dict, never raises
+if not report["ok"]:
+    raise SystemExit(report["problem"])
+```
+
+## Dependencies
+
+The only runtime dependency is `httpx>=0.27,<1`. If you pin your own transitive dependencies, keep
+`h11>=0.16` — older releases carry a request-smuggling advisory, and a fresh install picks a safe
+version on its own.