geodb-client 0.1.0__tar.gz

geodb_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 2026 Aqua Terra Geoscientists / geoDB
+
+   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.

geodb_client-0.1.0/PKG-INFO

@@ -0,0 +1,152 @@
+Metadata-Version: 2.4
+Name: geodb-client
+Version: 0.1.0
+Summary: Python client for the geoDB Open Exploration Protocol (drill, assay, geophysics, STAC, GeoParquet).
+Author-email: Aqua Terra Geoscientists / geoDB <joshua@geodb.io>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/geodbio/geodb-protocol
+Project-URL: Protocol, https://github.com/geodbio/geodb-protocol
+Project-URL: Documentation, https://github.com/geodbio/geodb-protocol/blob/main/AGENTS.md
+Keywords: geodb,mineral-exploration,drillhole,geophysics,stac,geoparquet
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Scientific/Engineering :: GIS
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests>=2.28
+Requires-Dist: pandas>=1.5
+Requires-Dist: pyarrow>=10
+Provides-Extra: geo
+Requires-Dist: geopandas>=0.12; extra == "geo"
+Provides-Extra: dev
+Requires-Dist: pytest>=7; extra == "dev"
+Requires-Dist: responses>=0.23; extra == "dev"
+Dynamic: license-file
+
+# geodb-client
+
+The Python client for the **[geoDB Open Exploration Protocol](https://github.com/geodbio/geodb-protocol)** —
+pull a mining-exploration project's drill, assay, geophysics, raster, and document
+data as pandas DataFrames and files, over one authenticated, project-scoped API.
+
+```bash
+pip install geodb-client            # + geopandas extra:  pip install "geodb-client[geo]"
+```
+
+## 20 lines to DataFrames
+
+```python
+import geodb
+
+gx = geodb.Client(token="gdbg_...", base_url="https://api.geodb.io")
+
+# Records lane — relational data straight to pandas
+collars       = gx.collars().to_dataframe()
+samples       = gx.samples().to_dataframe()
+assays        = gx.assays().to_dataframe()
+point_samples = gx.point_samples().to_dataframe()
+surveys       = gx.surveys().to_dataframe()          # geophysical surveys + footprints
+
+# Assets lane — walk the STAC catalog, download a Cloud-Optimized GeoTIFF
+for item in gx.stac().items("rasters"):
+    cog = item.asset("cog")
+    if cog:
+        cog.download("grid.tif")                     # short-SAS redirect, streamed
+        break
+
+# Bulk lane — GeoParquet export (zero-data-loss geometry + native coordinates)
+job = gx.export("drill_samples", format="geoparquet")
+job.wait().download("samples.parquet")
+```
+
+That's it — a vendor integrates a customer's project in an afternoon.
+
+## Auth
+
+A project owner mints a **project-pinned, read-only, revocable access grant** in
+geoDB (Project Settings → API Access Grants) and shares the token. The client
+sends it as `Authorization: Grant <token>`. Everything is scoped to that one
+project; every pull is logged for the owner to see. First-party callers can use a
+Knox token instead:
+
+```python
+gx = geodb.Client(token="<knox>", base_url="https://api.geodb.io", auth_scheme="Token")
+```
+
+Behind the `api.` subdomain rewrite, pass `api_prefix="/v2"`.
+
+## API
+
+| Call | Returns |
+|---|---|
+| **Records lane** — see the table list below | a `Paginated` iterator — iterate rows, or `.to_dataframe()`, or `.count()`. Accepts filter kwargs (e.g. `gx.surveys(method="magnetics")`, `gx.collars(modified_since="2024-01-01")`). |
+| `gx.stac()` | a `StacCatalog`: `.landing()`, `.collections()`, `.items(collection_id)` (yields `StacItem`), `.item(cid, iid)`. `StacItem.asset(key).download(path)`. |
+| `gx.export(model, format="geoparquet", include_assays=True)` | an `ExportJob`: `.wait()` then `.download(path)`. Formats: `geoparquet`, `parquet`, `csv`. Models: the `export()` column below. |
+| `gx.project()` | the grant/project context. |
+
+### Tables
+
+The drilling tables are the same ones geoDB serves to Leapfrog and Vulcan over
+ODBC — one definition of a project's drilling data, whichever door you come
+through.
+
+| Records lane | `export()` model | What it is |
+|---|---|---|
+| `gx.collars()` | `drill_collars` | Collar location, orientation, total depth |
+| `gx.drill_surveys()` | `drill_surveys` | Downhole survey stations (depth, azimuth, dip) |
+| `gx.lithology()` | `drill_lithology` | Downhole lithology intervals |
+| `gx.alteration()` | `drill_alteration` | Downhole alteration intervals |
+| `gx.samples()` | `drill_samples` | Drill samples (+ merged assays — see below) |
+| `gx.structures()` | `drill_structure_point`, `drill_structure_zone` | Structural measurements; point (a depth) vs zone (an interval) |
+| `gx.mineralization()` | `drill_mineralization` | Mineralization intervals + mineral percentages |
+| `gx.veins()` | `drill_veins` | Vein intervals (type, width, mineral contents) |
+| `gx.rqd()` | `drill_rqd` | Geotech: core recovery + rock mass |
+| — | `drill_rqd_core_recovery`, `drill_rqd_rock_mass` | The two halves, **only on projects that split their geotech tabs** |
+| `gx.spectral()` | `drill_spectral` | Spectral intervals (geounit abundances) |
+| `gx.custom_intervals()` | `drill_custom_intervals` | User-defined intervals (TYPE IS DATA) |
+| `gx.point_samples()` | `point_samples` | Surface / soil / rock-chip samples |
+| `gx.qc_samples()` | `qc_samples` | QA/QC (standards, blanks, duplicates) |
+| `gx.assays()` | — | Assay results (merged into the sample exports) |
+| `gx.surveys()` | `geophysical_surveys` | Geophysical surveys (metadata + WGS84 footprint) |
+
+Asking to `export()` a model your project does not expose returns HTTP 400 with
+the list it does — e.g. the two `drill_rqd_*` halves appear only when the
+project has the geotech tab split enabled, exactly as over ODBC.
+
+## What an export inherits
+
+An `export()` is not a raw table dump. It comes back the way the project is
+configured, the same as the project's own CSV/XLSX exports and its ODBC feed:
+
+- **Assay merge settings** — the sample exports carry merged assay columns per
+  the project's merge strategy and unit conversions (`include_assays=True`).
+- **Coordinate reference system** — coordinates honour the project's configured
+  output CRS (`odbc_output_crs`), not a forced WGS84.
+- **Column configuration** — visibility, ordering and display-name overrides.
+- **Custom fields** — as `cf_*` columns.
+- **Depth units** — metres or feet, per the project.
+
+## Coordinate contract
+
+GeoParquet exports carry a **WGS84 geometry** column plus the **native/original**
+coordinate columns (`latitude`/`longitude`/`epsg`) — zero-data-loss travels with
+the data, so you never lose the surveyor's original CRS.
+
+⚠️ On a UTM-imported project the `latitude`/`longitude` columns hold
+**northing/easting** in that project's CRS, not degrees — that is what "native"
+means, and `epsg` tells you how to read them. The `geometry` column is always
+WGS84. Read geometry for maps; read the natives when you need exactly what the
+surveyor recorded.
+
+## Development
+
+```bash
+pip install -e ".[dev,geo]"
+pytest                     # unit tests (mocked transport)
+GEODB_TEST_BASE_URL=http://localhost:8001 GEODB_TEST_TOKEN=gdbg_... pytest tests/test_integration.py
+```
+
+Apache-2.0. Version 0.1.0.

geodb_client-0.1.0/README.md

@@ -0,0 +1,124 @@
+# geodb-client
+
+The Python client for the **[geoDB Open Exploration Protocol](https://github.com/geodbio/geodb-protocol)** —
+pull a mining-exploration project's drill, assay, geophysics, raster, and document
+data as pandas DataFrames and files, over one authenticated, project-scoped API.
+
+```bash
+pip install geodb-client            # + geopandas extra:  pip install "geodb-client[geo]"
+```
+
+## 20 lines to DataFrames
+
+```python
+import geodb
+
+gx = geodb.Client(token="gdbg_...", base_url="https://api.geodb.io")
+
+# Records lane — relational data straight to pandas
+collars       = gx.collars().to_dataframe()
+samples       = gx.samples().to_dataframe()
+assays        = gx.assays().to_dataframe()
+point_samples = gx.point_samples().to_dataframe()
+surveys       = gx.surveys().to_dataframe()          # geophysical surveys + footprints
+
+# Assets lane — walk the STAC catalog, download a Cloud-Optimized GeoTIFF
+for item in gx.stac().items("rasters"):
+    cog = item.asset("cog")
+    if cog:
+        cog.download("grid.tif")                     # short-SAS redirect, streamed
+        break
+
+# Bulk lane — GeoParquet export (zero-data-loss geometry + native coordinates)
+job = gx.export("drill_samples", format="geoparquet")
+job.wait().download("samples.parquet")
+```
+
+That's it — a vendor integrates a customer's project in an afternoon.
+
+## Auth
+
+A project owner mints a **project-pinned, read-only, revocable access grant** in
+geoDB (Project Settings → API Access Grants) and shares the token. The client
+sends it as `Authorization: Grant <token>`. Everything is scoped to that one
+project; every pull is logged for the owner to see. First-party callers can use a
+Knox token instead:
+
+```python
+gx = geodb.Client(token="<knox>", base_url="https://api.geodb.io", auth_scheme="Token")
+```
+
+Behind the `api.` subdomain rewrite, pass `api_prefix="/v2"`.
+
+## API
+
+| Call | Returns |
+|---|---|
+| **Records lane** — see the table list below | a `Paginated` iterator — iterate rows, or `.to_dataframe()`, or `.count()`. Accepts filter kwargs (e.g. `gx.surveys(method="magnetics")`, `gx.collars(modified_since="2024-01-01")`). |
+| `gx.stac()` | a `StacCatalog`: `.landing()`, `.collections()`, `.items(collection_id)` (yields `StacItem`), `.item(cid, iid)`. `StacItem.asset(key).download(path)`. |
+| `gx.export(model, format="geoparquet", include_assays=True)` | an `ExportJob`: `.wait()` then `.download(path)`. Formats: `geoparquet`, `parquet`, `csv`. Models: the `export()` column below. |
+| `gx.project()` | the grant/project context. |
+
+### Tables
+
+The drilling tables are the same ones geoDB serves to Leapfrog and Vulcan over
+ODBC — one definition of a project's drilling data, whichever door you come
+through.
+
+| Records lane | `export()` model | What it is |
+|---|---|---|
+| `gx.collars()` | `drill_collars` | Collar location, orientation, total depth |
+| `gx.drill_surveys()` | `drill_surveys` | Downhole survey stations (depth, azimuth, dip) |
+| `gx.lithology()` | `drill_lithology` | Downhole lithology intervals |
+| `gx.alteration()` | `drill_alteration` | Downhole alteration intervals |
+| `gx.samples()` | `drill_samples` | Drill samples (+ merged assays — see below) |
+| `gx.structures()` | `drill_structure_point`, `drill_structure_zone` | Structural measurements; point (a depth) vs zone (an interval) |
+| `gx.mineralization()` | `drill_mineralization` | Mineralization intervals + mineral percentages |
+| `gx.veins()` | `drill_veins` | Vein intervals (type, width, mineral contents) |
+| `gx.rqd()` | `drill_rqd` | Geotech: core recovery + rock mass |
+| — | `drill_rqd_core_recovery`, `drill_rqd_rock_mass` | The two halves, **only on projects that split their geotech tabs** |
+| `gx.spectral()` | `drill_spectral` | Spectral intervals (geounit abundances) |
+| `gx.custom_intervals()` | `drill_custom_intervals` | User-defined intervals (TYPE IS DATA) |
+| `gx.point_samples()` | `point_samples` | Surface / soil / rock-chip samples |
+| `gx.qc_samples()` | `qc_samples` | QA/QC (standards, blanks, duplicates) |
+| `gx.assays()` | — | Assay results (merged into the sample exports) |
+| `gx.surveys()` | `geophysical_surveys` | Geophysical surveys (metadata + WGS84 footprint) |
+
+Asking to `export()` a model your project does not expose returns HTTP 400 with
+the list it does — e.g. the two `drill_rqd_*` halves appear only when the
+project has the geotech tab split enabled, exactly as over ODBC.
+
+## What an export inherits
+
+An `export()` is not a raw table dump. It comes back the way the project is
+configured, the same as the project's own CSV/XLSX exports and its ODBC feed:
+
+- **Assay merge settings** — the sample exports carry merged assay columns per
+  the project's merge strategy and unit conversions (`include_assays=True`).
+- **Coordinate reference system** — coordinates honour the project's configured
+  output CRS (`odbc_output_crs`), not a forced WGS84.
+- **Column configuration** — visibility, ordering and display-name overrides.
+- **Custom fields** — as `cf_*` columns.
+- **Depth units** — metres or feet, per the project.
+
+## Coordinate contract
+
+GeoParquet exports carry a **WGS84 geometry** column plus the **native/original**
+coordinate columns (`latitude`/`longitude`/`epsg`) — zero-data-loss travels with
+the data, so you never lose the surveyor's original CRS.
+
+⚠️ On a UTM-imported project the `latitude`/`longitude` columns hold
+**northing/easting** in that project's CRS, not degrees — that is what "native"
+means, and `epsg` tells you how to read them. The `geometry` column is always
+WGS84. Read geometry for maps; read the natives when you need exactly what the
+surveyor recorded.
+
+## Development
+
+```bash
+pip install -e ".[dev,geo]"
+pytest                     # unit tests (mocked transport)
+GEODB_TEST_BASE_URL=http://localhost:8001 GEODB_TEST_TOKEN=gdbg_... pytest tests/test_integration.py
+```
+
+Apache-2.0. Version 0.1.0.

geodb_client-0.1.0/geodb/__init__.py

@@ -0,0 +1,22 @@
+"""
+geodb-client — the Python client for the geoDB Open Exploration Protocol.
+
+    import geodb
+    gx = geodb.Client(token="gdbg_...", base_url="https://api.geodb.io")
+    collars = gx.collars().to_dataframe()
+
+See https://github.com/geodbio/geodb-protocol for the protocol spec.
+"""
+
+from .client import Client
+from .errors import (
+    GeodbError, AuthError, NotFoundError, APIError, ExportError,
+)
+
+__version__ = "0.1.0"
+
+__all__ = [
+    "Client",
+    "GeodbError", "AuthError", "NotFoundError", "APIError", "ExportError",
+    "__version__",
+]