vecorel-cli 0.1.0__tar.gz

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

vecorel_cli-0.1.0/PKG-INFO

@@ -0,0 +1,268 @@
+Metadata-Version: 2.4
+Name: vecorel-cli
+Version: 0.1.0
+Summary: CLI tools such as validation and file format conversion for vecorel.
+Author: Matthias Mohr
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/vecorel/cli
+Project-URL: Bug Reports, https://github.com/vecorel/cli/issues
+Project-URL: Source, https://github.com/vecorel/cli
+Classifier: Development Status :: 4 - Beta
+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
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyyaml<7.0,>=6.0
+Requires-Dist: click<9.0,>=8.1
+Requires-Dist: geopandas<2.0,>=1.0.0
+Requires-Dist: requests<3.0,>=2.30
+Requires-Dist: shapely<3.0,>=2.1
+Requires-Dist: numpy<2.2,>=2.0
+Requires-Dist: pyarrow<22.0,>=21.0
+Requires-Dist: py7zr<2.0,>=1.0
+Requires-Dist: fsspec==2025.7.0
+Requires-Dist: jsonschema[format]<5.0,>=4.20
+Requires-Dist: aiohttp<4.0,>=3.9
+Requires-Dist: yarl<2.0,>=1.20
+Requires-Dist: rarfile<5.0,>=4.0
+Requires-Dist: semantic-version<3.0,>=2.10.0
+Requires-Dist: json-stream<3.0,>=2.3.0
+Requires-Dist: flatdict<5.0,>=4.0
+Requires-Dist: loguru==0.7.3
+Dynamic: license-file
+
+# Vecorel CLI
+
+A command-line interface (CLI) for working with Vecorel files.
+
+- [Getting Started](#getting-started)
+- [Documentation / Commands](#commands)
+- [Development](#development)
+
+## Getting Started
+
+In order to make working with Vecorel easier we have developed command-line interface (CLI) tools such as
+inspection, validation and file format conversions.
+
+### Installation
+
+#### Using Pixi (Recommended)
+
+This project uses [Pixi](https://pixi.sh/) for dependency management. Install Pixi first, then:
+
+```bash
+# Clone the repository and navigate to it
+git clone https://github.com/vecorel/cli.git
+cd cli
+
+# Install all dependencies
+pixi install
+
+# Run the CLI
+pixi run vec
+```
+
+> **Note**: This project recently migrated to Pixi. If you were using the old pip-based workflow, see [MIGRATION.md](MIGRATION.md) for details.
+
+#### Using pip
+
+Alternatively, you can install from PyPI with **Python 3.10** or any later version:
+
+```bash
+pip install vecorel-cli
+```
+
+### Execute a command
+
+After the installation you should be able to run the following command: `vec` (or `pixi run vec` if using Pixi)
+
+You should see usage instructions and [available commands](#commands) for the CLI.
+
+Vecorel CLI supports various commands to work with the files:
+
+- [Vecorel CLI](#vecorel-cli)
+  - [Getting Started](#getting-started)
+    - [Installation](#installation)
+      - [Using Pixi (Recommended)](#using-pixi-recommended)
+      - [Using pip](#using-pip)
+    - [Execute a command](#execute-a-command)
+  - [Commands](#commands)
+    - [Validation](#validation)
+    - [Create Vecorel GeoParquet from GeoJSON](#create-vecorel-geoparquet-from-geojson)
+    - [Create Vecorel GeoJSON from GeoParquet](#create-vecorel-geojson-from-geoparquet)
+    - [Inspect Vecorel GeoParquet file](#inspect-vecorel-geoparquet-file)
+    - [Merge Vecorel GeoParquet files](#merge-vecorel-geoparquet-files)
+    - [Create JSON Schema from Vecorel Schema](#create-json-schema-from-vecorel-schema)
+    - [Validate a Vecorel Schema](#validate-a-vecorel-schema)
+    - [Improve a Vecorel Parquet file](#improve-a-vecorel-parquet-file)
+    - [Update an extension template with new names](#update-an-extension-template-with-new-names)
+    - [Converter for existing datasets](#converter-for-existing-datasets)
+  - [Development](#development)
+    - [Implement a converter](#implement-a-converter)
+
+## Commands
+
+### Validation
+
+To validate a Vecorel GeoParquet or GeoJSON file, you can for example run:
+
+- GeoJSON: `vec validate example.json --collection collection.json`
+- GeoParquet: `vec validate example.parquet --data`
+
+Check `vec validate --help` for more details.
+
+The validator also supports remote files.
+
+- `http://` or `https://`: no further configuration is needed.
+- `s3://`: With Pixi, run `pixi install -e s3` or with pip, run `pip install vecorel-cli[s3]` and you may need to set environment variables.
+  Refer to the [s3fs credentials documentation](https://s3fs.readthedocs.io/en/latest/#credentials) for how to define credentials.
+- `gs://`: With Pixi, run `pixi install -e gcs` or with pip, run `pip install vecorel-cli[gcs]`.
+  By default, `gcsfs` will attempt to use your default gcloud credentials or, attempt to get credentials from the google metadata service, or fall back to anonymous access.
+
+### Create Vecorel GeoParquet from GeoJSON
+
+To create a Vecorel-compliant GeoParquet for a Vecorel-compliant set of GeoJSON files containing Features or FeatureCollections,
+you can for example run:
+
+- `vec create-geoparquet geojson/example.json -o example.parquet -c geojson/collection.json`
+
+Check `vec create-geoparquet --help` for more details.
+
+### Create Vecorel GeoJSON from GeoParquet
+
+To create one or multiple Vecorel-compliant GeoJSON file(s) for a Vecorel-compliant GeoParquet file,
+you can for example run:
+
+- GeoJSON FeatureCollection:
+  `vec create-geojson example.parquet -o dest-folder`
+- GeoJSON Features (with indentation and max. 100 features):
+  `vec create-geojson example.parquet -o dest-folder -n 100 -i 2 -f`
+
+  `vec create-geojson example.parquet -o dest-folder -n 100 -i 2 -f`
+
+Check `vec create-geojson --help` for more details.
+
+### Inspect Vecorel GeoParquet file
+
+To look into a Vecorel GeoParquet file to get a rough understanding of the content, the following can be executed:
+
+- `vec describe example.parquet`
+
+Check `vec describe --help` for more details.
+
+### Merge Vecorel GeoParquet files
+
+Merges multiple Vecorel datasets to a combined Vecorel dataset:
+
+- `vec merge ec_ee.parquet ec_lv.parquet -o merged.parquet -e https://vecorel.github.io/hcat-extension/v0.1.0/schema.yaml -i ec:hcat_name -i ec:hcat_code -i ec:translated_name`
+
+Check `vec merge --help` for more details.
+
+### Create JSON Schema from Vecorel Schema
+
+To create a JSON Schema for a Vecorel Schema YAML file, you can for example run:
+
+- `vec jsonschema example.json --id=https://vecorel.github.io/specification/v0.1.0/geojson/schema.json -o schema.json`
+
+Check `vec jsonschema --help` for more details.
+
+### Validate a Vecorel Schema
+
+To validate a Vecorel Schema YAML file, you can for example run:
+
+- `vec validate-schema schema/schema.yaml`
+
+Check `vec validate-schema --help` for more details.
+
+### Improve a Vecorel Parquet file
+
+Various "improvements" can be applied to a Vecorel GeoParquet file.
+The commands allows to
+
+- change the CRS (`--crs`)
+- change the GeoParquet version (`-gp1`) and compression (`-pc`)
+- add/fill missing perimeter/area values (`-sz`)
+- fix invalid geometries (`-g`)
+- rename columns (`-r`)
+
+Example:
+
+- `vec improve file.parquet -o file2.parquet -g -sz -r old=new -pc zstd`
+
+Check `vec improve --help` for more details.
+
+### Update an extension template with new names
+
+Once you've created and git cloned a new extension, you can use the CLI
+to update all template placeholders with proper names.
+
+For example, if your extension is meant to have
+
+- the title "Administrative Division Extension",
+- the prefix `admin` (e.g. field `admin:country_code` or `admin:subdivision_code`),
+- is hosted at `https://github.io/vecorel/administrative-division-extension`
+  (organization: `vecorel`, repository `/administrative-division-extension`),
+- and you run Vecorel in the folder of the extension.
+
+Then the following command could be used:
+
+- `vec rename-extension . -t "Administrative Division" -p admin -s administrative-division-extension -o vecorel`
+
+Check `vec rename-extension --help` for more details.
+
+### Converter for existing datasets
+
+The CLI ships various converters for existing datasets.
+
+To get a list of available converters/datasets with title, license, etc. run:
+
+- `vec converters`
+
+Use any of the IDs from the list to convert an existing dataset to Vecorel:
+
+- `vec convert de_nrw`
+
+See [Implement a converter](#implement-a-converter) for details about how to
+
+## Development
+
+This project uses [Pixi](https://pixi.sh/) for dependency management and development workflows.
+
+```bash
+# Install all dependencies including development tools
+pixi install -e dev
+
+# Install the package in editable mode
+pixi run install-dev
+
+# Run tests
+pixi run test
+
+# Format and lint code
+pixi run format
+pixi run lint
+
+# Run all checks (lint, format, test)
+pixi run check
+
+# Install and run pre-commit
+pixi run pre-commit-install
+pixi run pre-commit-run
+```
+
+### Implement a converter
+
+The following high-level description gives an idea how to implement a converter in Vecorel CLI:
+
+1. Create a new file in `vecorel_cli/datasets` based on the `template.py`
+2. Fill in the required variables / test it / run it
+3. Add missing dependencies into the appropriate feature group in `pixi.toml` (or `setup.py` for pip users)
+4. Add the converter to the list above
+5. Create a PR to submit your converter for review
+
+An in-depth guide how to create a cloud-native Vecorel dataset using Vecorel CLI is available at:
+<https://github.com/vecorel/data/blob/main/HOWTO.md>