fit-changedetector 0.1.0a1__tar.gz

fit_changedetector-0.1.0a1/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 2024 Province of British Columbia
+
+   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.

fit_changedetector-0.1.0a1/PKG-INFO

@@ -0,0 +1,301 @@
+Metadata-Version: 2.4
+Name: fit_changedetector
+Version: 0.1.0a1
+Summary: Compare geo-data, report on diffs
+Author-email: Simon Norris <snorris@hillcrestgeo.ca>
+Project-URL: Homepage, https://github.com/bcgov/fit_changedetector
+Project-URL: Issues, https://github.com/bcgov/fit_changedetector
+Classifier: Development Status :: 1 - Planning
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Topic :: Scientific/Engineering :: GIS
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click
+Requires-Dist: cligj
+Requires-Dist: geopandas>=1.0.0
+Requires-Dist: pyarrow
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: build; extra == "test"
+Requires-Dist: pre-commit; extra == "test"
+Dynamic: license-file
+
+# FIT Change Detector
+
+[![Lifecycle:Maturing](https://img.shields.io/badge/Lifecycle-Maturing-007EC6)](https://github.com/bcgov/repomountie/blob/master/doc/lifecycle-badges.md)
+
+Compare two sets of geo-data and report on the differences.
+
+## Installation
+
+Install with pip:
+
+    pip install fit_changedetector
+
+An ArcGIS Pro script tool is also provided (`arcgis.py`).
+Because an ArcGIS managed conda environment is unlikely to be 100% compatible with this module's dependencies, installation of this module to a virtual environment is recommended:
+
+In a Windows Command Prompt (with no active conda environment):
+
+    python -m venv .venv
+    .venv\Scripts\activate.bat
+    pip install fit_changedetector
+
+Set the `FIT_CHANGEDETECTOR_VENV_PYTHON` environment variable to the path of `python.exe` in your virtual environment (e.g. via `setx FIT_CHANGEDETECTOR_VENV_PYTHON "C:\path\to\.venv\Scripts\python.exe"`, or through Windows' System Properties > Environment Variables), then drop `arcgis.py` into your ArcGIS toolbox. If you don't have permission to set an environment variable, instead create a `venv_python.txt` file next to `arcgis.py` in the toolbox folder, containing just the path to `python.exe`. To avoid conflict with the system Python, the script tool passes the arguments provided in the ArcGIS tool to the change detector CLI - which is run in a subprocess using the virtual environment's Python.
+
+
+## Usage
+
+#### Python module
+
+The primary function of interest is `gdf_diff()`:
+
+    import geopandas
+    import fit_changedetector as fcd
+
+    # read the data
+    df_a = geopandas.read_file(in_file_a, layer=layer_a)
+    df_b = geopandas.read_file(in_file_b, layer=layer_b)
+
+    # compare the two dataframes
+    diff = fcd.gdf_diff(
+        df_a,
+        df_b,
+        <primary_key>,
+        fields=<fields_to_compare>,
+        precision=<precision>,
+        suffix_a="a",
+        suffix_b="b",
+    )
+
+`gdf_diff` returns a dictionary having the keys noted below. Dictionary values are geopandas GeoDataFrames holding the corresponding records.
+
+Dictionary keys:
+
+| key | description |
+|-----|-------------|
+| `NEW` | additions |
+| `DELETED` | deleted records |
+| `UNCHANGED` | unchanged records |
+| `MODIFIED_BOTH` | records where attribute columns and geometries have changed |
+| `MODIFIED_ATTR` | records where attribute columns have changed but geometries have not changed |
+| `MODIFIED_GEOM` | records where geometries have changed but attribute columns have not |
+| `DUPLICATES` | records dropped due to a duplicated primary key (only populated if `allow_duplicates=True`) |
+
+Schemas for records contained in `NEW`, `DELETED`, `UNCHANGED` are as per the source data. `DUPLICATES` records retain their source schema too, plus a `_fcd_source_` column (`suffix_a`/`suffix_b`) identifying which source each record was dropped from.
+Schemas for records contained in the `MODIFIED` keys include only columns where a change has occurred.
+For example, these are some "modified attributes" records, with "_a" suffix for values from the primary dataset, and "_b" suffix for values from the secondary dataset:
+
+    >>> diff["MODIFIED_ATTR"]
+      id       park_name_a                park_name_b parkclasscode_a parkclasscode_b
+    0  3  Mars Street Park        Jupiter Street Park             NaN             NaN
+    1  6      Mayfair Blue              Mayfair Green              BL             GRN
+    2  7                    Quadra Heights Playground             NaN             NaN
+    3  9               NaN                        NaN              RP             PND
+
+
+#### CLI
+
+<!-- BEGIN CLI HELP (auto-generated by scripts/update_cli_docs.py - do not edit by hand) -->
+    $ changedetector --help
+    Usage: changedetector [OPTIONS] COMMAND [ARGS]...
+
+    Options:
+      --version  Show the version and exit.
+      --help     Show this message and exit.
+
+    Commands:
+      add-hash-key  Read input data, compute hash, write to new file
+      diff          Compare two datasets, printing a JSON summary to stdout
+      diff2gdb      Compare two datasets, writing results to .gdb
+
+    $ changedetector add-hash-key --help
+    Usage: changedetector add-hash-key [OPTIONS] IN_FILE OUT_FILE
+
+      Read input data, compute hash, write to new file
+
+    Options:
+      --in-layer TEXT           Name of layer to add hashed primary key
+      -nln, --out-layer TEXT    Output layer name
+      -hk, --hash-key TEXT      Name of new column containing hashed data
+      -d, --drop-null-geometry  Drop records with null geometry
+      -hf, --hash-fields TEXT   Comma separated list of fields to include in the
+                                hash (not including geometry)
+      -p, --precision FLOAT     Coordinate precision for geometry hash and
+                                comparison. Default=0.01
+      --crs TEXT                Coordinate reference system to use when hashing
+                                geometries (eg EPSG:3005)
+      -v, --verbose             Increase verbosity.
+      -q, --quiet               Decrease verbosity.
+      --help                    Show this message and exit.
+
+    $ changedetector diff --help
+    Usage: changedetector diff [OPTIONS] IN_FILE_A IN_FILE_B
+
+      Compare two datasets, printing a JSON summary to stdout
+
+      Same comparison as `diff2gdb`, but for when spatial output isn't needed -
+      prints a JSON summary instead of writing a .gdb: record counts per
+      NEW/DELETED/UNCHANGED/MODIFIED_* category, plus the primary key value(s)
+      present in each category (use --count to omit the key lists and print just the
+      counts).
+
+      IN_FILE_A may be "-" to read GeoJSON from stdin instead of a file.
+
+    Options:
+      --layer-a TEXT             Name of layer to use within in_file_a (not valid if
+                                 reading from stdin/parquet)
+      --layer-b TEXT             Name of layer to use within in_file_b (not valid if
+                                 reading from parquet)
+      -f, --fields TEXT          Comma separated list of fields to compare (do not
+                                 include primary key)
+      -if, --ignore-fields TEXT  Comma separated list of fields to ignore
+      -pk, --primary-key TEXT    Comma separated list of primary key column(s),
+                                 common to both datasets
+      -hk, --hash-key TEXT       Name of new column to add as hash key
+      -hf, --hash-fields TEXT    Comma separated list of fields to include in the
+                                 hash (in addition to geometry)
+      -p, --precision FLOAT      Coordinate precision for geometry hash and
+                                 comparison. Default=0.01
+      -a, --suffix-a TEXT        Suffix to append to column names from data source A
+                                 when comparing attributes
+      -b, --suffix-b TEXT        Suffix to append to column names from data source B
+                                 when comparing attributes
+      -d, --drop-null-geometry   Drop records with null geometry
+      --crs TEXT                 Coordinate reference system to use when hashing
+                                 geometries (eg EPSG:3005)
+      -c, --count                Print only record counts, omitting the primary key
+                                 values in each category
+      --allow-duplicates         Do not fail on a duplicated primary key - instead,
+                                 drop all but the first occurrence of each
+                                 duplicated key from the source it was found in, and
+                                 include a DUPLICATES category in the output
+      -v, --verbose              Increase verbosity.
+      -q, --quiet                Decrease verbosity.
+      --help                     Show this message and exit.
+
+    $ changedetector diff2gdb --help
+    Usage: changedetector diff2gdb [OPTIONS] IN_FILE_A IN_FILE_B
+
+      Compare two datasets, writing results to .gdb
+
+      IN_FILE_A may be "-" to read GeoJSON from stdin instead of a file.
+
+    Options:
+      --layer-a TEXT             Name of layer to use within in_file_a (not valid if
+                                 reading from stdin/parquet)
+      --layer-b TEXT             Name of layer to use within in_file_b (not valid if
+                                 reading from parquet)
+      -f, --fields TEXT          Comma separated list of fields to compare (do not
+                                 include primary key)
+      -if, --ignore-fields TEXT  Comma separated list of fields to ignore
+      -o, --out-file PATH        Path to output file, defaults to
+                                 ./changedetector_YYYYMMDD_HHMM.gdb
+      -pk, --primary-key TEXT    Comma separated list of primary key column(s),
+                                 common to both datasets
+      -hk, --hash-key TEXT       Name of new column to add as hash key
+      -hf, --hash-fields TEXT    Comma separated list of fields to include in the
+                                 hash (in addition to geometry)
+      -p, --precision FLOAT      Coordinate precision for geometry hash and
+                                 comparison. Default=0.01
+      -a, --suffix-a TEXT        Suffix to append to column names from data source A
+                                 when comparing attributes
+      -b, --suffix-b TEXT        Suffix to append to column names from data source B
+                                 when comparing attributes
+      -d, --drop-null-geometry   Drop records with null geometry
+      -i, --dump-inputs          Dump input layers (with new hash key) to output
+                                 .gdb
+      --crs TEXT                 Coordinate reference system to use when hashing
+                                 geometries (eg EPSG:3005)
+      --allow-duplicates         Do not fail on a duplicated primary key - instead,
+                                 drop all but the first occurrence of each
+                                 duplicated key from the source it was found in, and
+                                 write the dropped records to a DUPLICATES layer
+      -v, --verbose              Increase verbosity.
+      -q, --quiet                Decrease verbosity.
+      --help                     Show this message and exit.
+<!-- END CLI HELP -->
+
+##### Examples
+
+Compare the test datasets using their known primary key:
+
+    $ changedetector diff2gdb -v \
+        tests/data/parks_a.geojson \
+        tests/data/parks_b.geojson \
+        -pk id
+
+Compare the test datasets, using a hash of geometry and the column `park_name` as synthetic primary key, written to `new_hash_column`:
+
+    $ changedetector diff2gdb -v \
+        tests/data/parks_a.geojson \
+        tests/data/parks_b.geojson \
+        -hf park_name \
+        -hk new_hash_column
+
+`IN_FILE_A` may be `-` to read GeoJSON from stdin instead of a file, e.g. to compare a database export against a file on disk without writing the export to disk first:
+
+    $ ogr2ogr -f GeoJSON /vsistdout/ PG:"dbname=mydb" -sql "SELECT * FROM my_table" | \
+        changedetector diff2gdb -v - tests/data/parks_b.geojson -pk id
+
+`diff` prints record counts per category plus the primary key value(s) present in each by default; add `--count`/`-c` to print just the counts:
+
+    $ changedetector diff tests/data/parks_a.geojson tests/data/parks_b.geojson -pk id
+    {"NEW": 1, "DELETED": 1, "UNCHANGED": 1, "MODIFIED_BOTH": 1, "MODIFIED_ATTR": 4, "MODIFIED_GEOM": 1, "keys": {"NEW": ["8"], "DELETED": ["2"], "UNCHANGED": ["1"], "MODIFIED_BOTH": ["5"], "MODIFIED_ATTR": ["3", "6", "7", "9"], "MODIFIED_GEOM": ["4"]}}
+
+    $ changedetector diff tests/data/parks_a.geojson tests/data/parks_b.geojson -pk id --count
+    {"NEW": 1, "DELETED": 1, "UNCHANGED": 1, "MODIFIED_BOTH": 1, "MODIFIED_ATTR": 4, "MODIFIED_GEOM": 1}
+
+##### Usage notes
+
+Layer options are not valid for stdin and parquet sources - streams and parquet files have no concept of multiple layers.
+
+A *partitioned* parquet dataset (a directory of many `.parquet` files) is not supported as a single source - `diff`/`diff2gdb` load an entire source into memory regardless of format, so there's no benefit to teaching them to read a partition directory as one dataset. Instead, run the command once per file, e.g. for two partitioned datasets with matching partition filenames:
+
+    $ for part in dataset_a/*.parquet; do
+        name=$(basename "$part" .parquet)
+        changedetector diff2gdb -v \
+            "$part" \
+            "dataset_b/${name}.parquet" \
+            -pk id \
+            -o "output_${name}.gdb"
+      done
+
+Neither `diff` nor `diff2gdb` have a bounding box / spatial filtering option, and won't - applying a bbox filter independently to each source risks reporting spurious `NEW`/`DELETED` records for anything that moved across the boundary between the two snapshots being compared, rather than genuinely appearing/disappearing from the source. Filter with another tool first, e.g.:
+
+    $ ogr2ogr -f GeoJSON /vsistdout/ dataset_a.gpkg -spat 1150000 470000 1200000 500000 | \
+        changedetector diff2gdb -v - dataset_b.gpkg -pk id
+
+
+#### ArcGIS
+
+The script tool calls the above documented CLI. Documentation of the parameters is also provided within the ArcGIS interface.
+
+## Subtleties to geometry change detection
+
+Prior to comparing geometries, the tool will:
+
+- normalize geometries (vertex order/starting point or ring winding direction)
+- promote mixed single/multipart types to multipart (when a source contains both variants — a uniformly single-part source compared against a uniformly multi-part source will still raise a type mismatch)
+- apply coordinate precision tolerance (`-p`/`--precision`, default 0.01)
+
+On the other hand, a new vertex in an otherwise unchanged geometry will be considered as MODIFIED_GEOM.
+See geopandas [geom_equals_exact](https://geopandas.org/en/stable/docs/reference/api/geopandas.GeoSeries.geom_equals_exact.html) for details.
+
+Curved geometry types (`CIRCULARSTRING`, `COMPOUNDCURVE`, `CURVEPOLYGON`, etc, as found in some `.gdb` sources) are not supported - only `POINT`, `LINESTRING`, `POLYGON` and their `MULTI*` equivalents are ([#66](https://github.com/bcgov/FIT_changedetector/issues/66)). GDAL segments curves into their linear approximation on read, so a curved source may appear to work, but the precision of that approximation is not controlled by `diff`/`diff2gdb` and results involving curved input should not be relied on.
+
+
+
+## Development and testing
+
+Uses [uv](https://docs.astral.sh/uv/) for dependency management:
+
+    $ git clone git@github.com:bcgov/FIT_changedetector.git
+    $ cd FIT_changedetector
+    $ uv sync --extra test
+    $ uv run pytest