geojibe 0.1.0__tar.gz

geojibe-0.1.0/LICENSE

@@ -0,0 +1,191 @@
+                                 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 such Contributor, or claims asserted against such
+      Contributor, by reason of your accepting any such warranty or
+      additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright AcuGIS
+
+   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.

geojibe-0.1.0/PKG-INFO

@@ -0,0 +1,307 @@
+Metadata-Version: 2.5
+Name: geojibe
+Version: 0.1.0
+Summary: Official Python SDK and CLI for the GeoJibe geospatial processing platform and API.
+Project-URL: Homepage, https://geojibe.com
+Project-URL: Documentation, https://geojibe.com/guides
+Author: AcuGIS
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: cli,etl,geojibe,geospatial,gis
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+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 :: Scientific/Engineering :: GIS
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: rich>=13
+Requires-Dist: tomli-w>=1.0
+Requires-Dist: tomli>=2.0.1; python_version < '3.11'
+Requires-Dist: typer>=0.12
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: twine>=6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# geojibe
+
+Official Python SDK and CLI for the [GeoJibe](https://geojibe.com) geospatial
+processing platform and API.
+
+`geojibe` is an HTTPS client for an existing GeoJibe installation. Processing
+stays on the server. It does **not** require Docker, GDAL, DuckDB, QGIS, Go, or
+a local GeoJibe server.
+
+Fuller product documentation: [GeoJibe Guides](https://geojibe.com/guides),
+including the [command-line client](https://geojibe.com/guides/reference/cli/).
+
+## Install
+
+This package is **not published on PyPI yet**. After the first public release,
+the intended command will be:
+
+```bash
+pip install geojibe
+```
+
+Until then, from a source checkout, Python 3.10 or newer:
+
+```bash
+cd clients/python
+python -m pip install -e .
+```
+
+That provides the `geojibe` executable and the `geojibe` Python package.
+
+## Authenticate
+
+Create a Personal Access Token in **GeoJibe → Account → API Tokens**, then:
+
+```bash
+geojibe auth login
+```
+
+Enter the GeoJibe URL (your installation origin, for example
+`https://geojibe.example.com` — not an `/api/v1` path) and the token.
+Token input is hidden. On success: `Authenticated successfully.`
+
+## Use
+
+```bash
+geojibe jobs list
+geojibe sources list
+geojibe destinations list
+geojibe recipes list
+geojibe jobs run <id>
+geojibe workspace upload roads.gpkg
+geojibe transformations list
+```
+
+`--json` writes machine-readable JSON to stdout:
+
+```bash
+geojibe jobs list --json
+ID=$(geojibe workspace upload roads.gpkg --json | jq -r '.id')
+```
+
+## Automation
+
+```bash
+export GEOJIBE_URL=https://geojibe.example.com
+export GEOJIBE_TOKEN=gjp_...
+
+geojibe jobs list --json
+```
+
+Do not hard-code a hosted GeoJibe URL. Shared, Dedicated, and On-Site
+installations each have their own origin.
+
+Credential precedence, highest wins:
+
+1. `--url` / `--token`
+2. `GEOJIBE_URL` / `GEOJIBE_TOKEN`
+3. Saved configuration
+
+## Configuration
+
+`geojibe config set-url` and `geojibe config set-token` write a user-level
+file, never the current working directory:
+
+| OS | Path |
+| --- | --- |
+| Linux | `~/.config/geojibe/config.toml` (`$XDG_CONFIG_HOME` if set) |
+| macOS | `~/Library/Application Support/geojibe/config.toml` |
+| Windows | `%APPDATA%\geojibe\config.toml` |
+
+That file may contain a Personal Access Token. Permissions are set to `0600`
+on Unix. `geojibe config show` prints a masked token only.
+
+Logout removes the local token. It does not revoke the PAT. Revoke tokens in
+**Account → API Tokens**.
+
+```bash
+geojibe auth status
+geojibe auth logout
+```
+
+## Commands
+
+```
+geojibe --help
+geojibe --version
+
+geojibe auth …
+geojibe config …
+geojibe sources list|get|create|delete
+geojibe destinations list|get|create|delete
+geojibe jobs list|get|run|enable|disable|delete|create|update|runs|retry
+geojibe recipes list|get|create|delete
+geojibe workspace upload|info|preview|convert|download
+geojibe workspace transform get|set|clear|preview
+geojibe transformations list|show
+```
+
+Workspace processing is remote. Discover operations with
+`geojibe transformations list` and `geojibe transformations show <id>`.
+
+```bash
+geojibe workspace transform set <id> --file pipeline.json
+```
+
+```json
+{
+  "layers": ["apiary"],
+  "operations": [
+    {"type": "buffer", "distance": 10, "units": "source"}
+  ]
+}
+```
+
+`--debug` prints HTTP method, URL, and status to stderr (never the token).
+`--insecure` disables TLS verification for development certificates only and is
+not saved. TLS verification is on by default.
+
+`geojibe jobs create --file job.json` sends the public API body
+(`POST /api/v1/jobs`) unchanged.
+
+```json
+{
+  "name": "Neighborhoods",
+  "source_id": "…",
+  "transform_mode": "sql",
+  "sql": "SELECT * FROM source WHERE population > 1000",
+  "output_format": "GeoJSON",
+  "destination_id": "…",
+  "destination_target": {"schema": "public", "table": "neighborhoods", "write_mode": "replace"},
+  "schedule": {"kind": "daily", "timezone": "UTC", "hour": 2, "minute": 0}
+}
+```
+
+## Python
+
+```python
+from geojibe import GeoJibe, ValidationError
+
+client = GeoJibe(
+    url="https://geojibe.example.com",
+    token="gjp_...",
+)
+```
+
+`url` and `token` may also come from `GEOJIBE_URL` and `GEOJIBE_TOKEN` when
+omitted. Explicit constructor arguments always win. The token is sent as
+`Authorization: Bearer` and is never logged, stored, or included in
+exceptions.
+
+```python
+client.me()
+```
+
+### Upload
+
+```python
+ws = client.workspaces.upload("roads.gpkg")
+print(ws.id, ws.status, ws.layers)
+```
+
+### Preview
+
+```python
+rows = ws.preview_data("roads", limit=50)
+geojson = ws.preview_map("roads")["geojson"]
+```
+
+`preview_data` and `preview_map` return the server JSON, including fields,
+counts, truncation, and CRS. `preview_map()["geojson"]` is a GeoJSON
+FeatureCollection. Visualization is up to the caller.
+
+### Transform
+
+Discover operations from the server (do not hard-code a catalog):
+
+```python
+ops = client.transformations.list()
+```
+
+```python
+ws.set_transformations(
+    layers=["roads"],
+    operations=[{"type": "buffer", "distance": 10, "units": "source"}],
+)
+```
+
+SQL and Python are sibling fields, not operation types:
+
+```python
+ws.set_transformations(layers=["roads"], sql="SELECT * FROM source")
+ws.set_transformations(python={"script": script, "filename": "script.py"})
+ws.clear_transformations()
+```
+
+### Transformed preview
+
+Uses the stored pipeline. The SDK does not resend or execute it locally.
+
+```python
+ws.preview_transformed_data("roads", limit=50)
+ws.preview_transformed_map("roads")
+```
+
+### Convert and download
+
+```python
+ws.convert(output_format="GeoJSON", layers=["roads"])
+output = ws.download("roads.geojson")
+```
+
+Download streams to disk. An existing file is not overwritten unless you pass
+`overwrite=True`. Convert is currently synchronous (`status=completed`).
+
+Saved Sources, Destinations, Recipes, and Jobs keep their existing methods:
+
+```python
+jobs = client.jobs.list()
+client.jobs.run(jobs[0]["id"])
+```
+
+### Errors
+
+```python
+try:
+    ws.preview_transformed_map("other_layer")
+except ValidationError as exc:
+    print(exc.status_code, exc.code, exc.message, exc.details)
+```
+
+`timeout` (default 30s) is the ordinary HTTP timeout. `run_timeout` (default
+600s) is used for upload, preview, convert, and download.
+
+## Exit codes
+
+| Code | Meaning |
+| --- | --- |
+| 0 | Success |
+| 1 | Failure (including a finished Run with status `failed`) |
+| 2 | Usage / local config |
+| 3 | Authentication (401 / missing credentials) |
+| 4 | Authorization (403 / missing PAT scope) |
+| 5 | Not found (404) |
+| 6 | Validation (400 / 409 / 422) |
+| 7 | Network (DNS, connection refused, TLS, timeout) |
+| 8 | GeoJibe server error (5xx) |
+
+## Security
+
+- PAT is sent as `Authorization: Bearer`, never as a query parameter
+- Full PAT is not printed by `config show`, `auth status`, or default errors
+- Source and Destination secrets from the API are not displayed