Merge pull request #1 from stacchain/nested-items

Add support for nested items

Author: jonhealy1

CHANGELOG.md

@@ -17,6 +17,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+## [v0.2.0] - 2024-11-16
+
+### Added
+
+- Enhanced collection processing to support nested subdirectories for items [#1](https://github.com/stacchain/stac-merkle-tree-cli/pull/1)
+- Test to ensure `merkle:root` values remain the same whether items are nested or not [#1](https://github.com/stacchain/stac-merkle-tree-cli/pull/1)
+
 ## [v0.1.1] - 2024-11-16
 
 ### Fixed

README.md

@@ -61,7 +61,37 @@ pip install stac-merkle-tree-cli
 
 ## Directory Structure
 
-Ensure your STAC catalog follows the directory structure below for optimal processing:
+Ensure your STAC catalog follows one of the directory structures below for optimal processing:
+
+### Standard Flat Structure
+
+In this structure, all items are at the same level as the `collection.json` file:
+
+```bash
+collection/
+├── collection.json
+├── item1.json
+├── item2.json
+└── ...
+```
+
+### Nested Structure
+
+In this structure, items can be nested inside their own subdirectories within a collection:
+
+```bash
+collection/
+├── collection.json
+├── item1/
+│   └── item1.json
+├── item2/
+│   └── item2.json
+└── ...
+```
+
+### Catalog with Collections and Nested Items
+
+A full STAC catalog with collections, where items can be either at the same level as the `collection.json` or nested within subdirectories:
 
 ```bash
 catalog/
@@ -70,13 +100,14 @@ catalog/
 │   ├── collection1/
 │   │   ├── collection.json
 │   │   ├── item1.json
-│   │   ├── item2.json
-│   │   └── ...
+│   │   ├── item2/
+│   │   │   └── item2.json
 │   ├── collection2/
 │   │   ├── collection.json
-│   │   ├── item1.json
-│   │   └── ...
-│   └── ...
+│   │   ├── item1/
+│   │   │   └── item1.json
+│   │   └── item2.json
+└── ...
 ```
 
 - **Catalog Level**:
@@ -86,7 +117,7 @@ catalog/
   - Each collection has its own directory inside `collections/`, named after the collection.
   - Inside each collection directory:
     - `collection.json`: Collection metadata.
-    - `item.json`, `item2.json`, ...: Items belonging to the collection.
+    - `item.json`, `item2.json`, ...: Items belonging to the collection, either at the same level or nested within subdirectories.
 
 ## Usage
 
@@ -97,7 +128,7 @@ After installing the package, you can use the `stac-merkle-tree-cli` command to
 Navigate to the directory containing your catalog.json file and run the command as follows:
 
 ```bash
-stac-merkle-cli path/to/catalog.json
+stac-merkle-tree-cli path/to/catalog.json
 ```
 
 ### Example
@@ -111,18 +142,19 @@ my_stac_catalog/
 │   ├── collection1/
 │   │   ├── collection.json
 │   │   ├── item1.json
-│   │   └── item2.json
+│   │   └── item2/
+│   │       └── item2.json
 │   └── collection2/
 │       ├── collection.json
-│       ├── item1.json
+│       ├── item1/
+│       │   └── item1.json
 │       └── item2.json
-
 ```
 
 Run the tool:
 
 ```bash
-stac-merkle-tree-cli ./my_stac_catalog/catalog.json
+stac-merkle-tree-cli my_stac_catalog/catalog.json
 ```
 
 Expected Output:

example_catalog/catalog.json

@@ -55,14 +55,14 @@
   "stac_extensions": [
     "https://stacchain.github.io/merkle-tree/v1.0.0/schema.json"
   ],
-  "merkle:object_hash": "b14fd102417c1d673f481bc053d19946aefdc27d84c584989b23c676c897bd5a",
-  "merkle:root": "e3f79fe1a806f083fb6a3e5d7b052a0bed84f69c4b5c5969ddc4e39e0255f997",
+  "merkle:object_hash": "4adf81a9aba90fe1f483ec3bbe7c628309e598239cee45d4aeafa1bc8c767ae6",
+  "merkle:root": "6dcb155aa44f0384cf23af6843fb0505d752b11aaaa0778829889b9d598c176f",
   "merkle:hash_method": {
     "function": "sha256",
     "fields": [
       "*"
     ],
     "ordering": "ascending",
-    "description": "Computed by excluding Merkle fields and including merkle:object_hash values in ascending order to build the Merkle tree."
+    "description": "Computed by including the merkle:root of collections and the catalogs own merkle:object_hash."
   }
 }

example_catalog/collections/COP-DEM/DEM1_SAR_DGE_30_20101212T230244_20140325T230302_ADS_000000_1jTi.json

@@ -43,7 +43,7 @@
     "datetime": "2010-12-12T23:02:44.000000Z",
     "end_datetime": "2014-03-25T23:03:02.000000Z",
     "start_datetime": "2010-12-12T23:02:44.000000Z",
-    "merkle:object_hash": "ce9f56e695ab1751b8f0c8d9ef1f1ecedaf04574ec3077e70e7426ec9fc61ea4"
+    "merkle:object_hash": "32c896520ed1fc38a93e59877cb6a88a5e795721eeae3bf6e7bd29206efb87af"
   },
   "bbox": [
     99,

example_catalog/collections/COP-DEM/DEM1_SAR_DGE_30_20101212T230244_20140329T113710_ADS_000000_eAmG.json

@@ -43,7 +43,7 @@
     "datetime": "2010-12-12T23:02:44.000000Z",
     "end_datetime": "2014-03-29T11:37:10.000000Z",
     "start_datetime": "2010-12-12T23:02:44.000000Z",
-    "merkle:object_hash": "ac66e07717b56e8421c8fec00b2b300afd49d30a8ec9c6d505df3b0568de9c77"
+    "merkle:object_hash": "9c6b0b011ec783f4bcdec7c712c2443c3c6eca6d1a0d043842a7c8d587d767c4"
   },
   "bbox": [
     100,

example_catalog/collections/COP-DEM/DEM1_SAR_DGE_30_20101215T103647_20130405T103047_ADS_000000_RHJx.json

@@ -43,7 +43,7 @@
     "datetime": "2010-12-15T10:36:47.000000Z",
     "end_datetime": "2013-04-05T10:30:47.000000Z",
     "start_datetime": "2010-12-15T10:36:47.000000Z",
-    "merkle:object_hash": "39969fd5f4a3a170ff39df8f2c13ebca66aab40890275a94ce798e281b85d54d"
+    "merkle:object_hash": "762a6152760f8d4868e4036b2ad009a948485e2626c51c6db2a506fc2c7e491c"
   },
   "bbox": [
     98,

example_catalog/collections/COP-DEM/DEM1_SAR_DGE_30_20101215T103647_20130405T103047_ADS_000000_oCX9.json

@@ -43,7 +43,7 @@
     "datetime": "2010-12-15T10:36:47.000000Z",
     "end_datetime": "2013-04-05T10:30:47.000000Z",
     "start_datetime": "2010-12-15T10:36:47.000000Z",
-    "merkle:object_hash": "22a31ab988181f280a0bfc6872556ad1d670373bd997f711389d057e1b1f531a"
+    "merkle:object_hash": "b56b4a839810159bfbcd77fe458bcf12173e796a6750b31399166c67cfd29c33"
   },
   "bbox": [
     100,

example_catalog/collections/COP-DEM/DEM1_SAR_DGE_30_20101215T203649_20140913T090954_ADS_000000_4KBA.json

@@ -43,7 +43,7 @@
     "datetime": "2010-12-15T20:36:49.000000Z",
     "end_datetime": "2014-09-13T09:09:54.000000Z",
     "start_datetime": "2010-12-15T20:36:49.000000Z",
-    "merkle:object_hash": "3c22648957e7c76f75a9fbfdf7c164e7d745d9e4ebe809db15d2474e01be4764"
+    "merkle:object_hash": "df89c14ec6017be8ad68b8a51f1152671520a8959c65a7a377cfc2b789f30708"
   },
   "bbox": [
     135,

example_catalog/collections/COP-DEM/DEM1_SAR_DGE_30_20101215T203649_20140913T090954_ADS_000000_Quqd.json

@@ -43,7 +43,7 @@
     "datetime": "2010-12-15T20:36:49.000000Z",
     "end_datetime": "2014-09-13T09:09:54.000000Z",
     "start_datetime": "2010-12-15T20:36:49.000000Z",
-    "merkle:object_hash": "6d16f23e2fe2849ce0316c012e9284b413f7c086a11d6de421c0582b397f513e"
+    "merkle:object_hash": "7365039727dfa4456a355cd02585e713af706692716bf0b6050c1b8e82e1308f"
   },
   "bbox": [
     135,

example_catalog/collections/COP-DEM/DEM1_SAR_DGE_30_20101215T203914_20121226T204852_ADS_000000_Yjwo.json

@@ -43,7 +43,7 @@
     "datetime": "2010-12-15T20:39:14.000000Z",
     "end_datetime": "2012-12-26T20:48:52.000000Z",
     "start_datetime": "2010-12-15T20:39:14.000000Z",
-    "merkle:object_hash": "ed99b4348ede45959a9cf471490f0f2c6a106bb4337a46d07d4fc4b4988f099f"
+    "merkle:object_hash": "b2bb980dc3b1d92106f009b6c732b7140533e622f3e06801dedd643eb9a8614c"
   },
   "bbox": [
     134,