geometamaker 0.1.2__py3-none-any.whl → 0.2.0__py3-none-any.whl

{geometamaker-0.1.2.dist-info → geometamaker-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: geometamaker
-Version: 0.1.2
+Version: 0.2.0
 Summary: metadata creation for geospatial data
 Maintainer: Natural Capital Project Software Team
 License: 
@@ -236,16 +236,23 @@ Requires-Dist: Pydantic>=2.0
 Requires-Dist: pygeoprocessing>=2.4.5
 Requires-Dist: pyyaml
 Requires-Dist: requests
+Dynamic: license-file
 
-A Python library for creating human and machine-readable metadata for geospatial data.
+## Introduction
+
+GeoMetaMaker is a Python library for creating human and machine-readable
+metadata for geospatial, tabular, and other data formats.
 
 Supported datatypes include:
 * everything supported by GDAL
 * tabular formats supported by `frictionless`
 * compressed formats supported by `frictionless`
 
+## Installation
+
+`mamba install -c conda-forge geometamaker`
 
-See `requirements.txt` for dependencies.
+## Basic Usage
 
 This library comes with a command-line interface (CLI) called `geometamaker`.
 Many of the examples below show how to use the Python interface, and then
@@ -282,6 +289,8 @@ resource.set_band_description(
 
 resource.write()
 ```
+For a complete list of methods and attributes:
+https://geometamaker.readthedocs.io/en/latest/index.html
 
 ##### CLI
 ```
@@ -293,22 +302,30 @@ user-input. If you create a metadata document with the CLI, you may wish
 to add these values manually by editing the 
 `watershed_gura.shp.yml` file in a text editor.
 
-### Creating metadata for a batch of files:
+### Creating metadata for a collection of files:
+Users can create a single metadata document to describe a directory of 
+files, with the option of excluding some files using a regular expression,
+or limiting the number of subdirectory levels to traverse using the
+`depth` or `-d` flag.
 
 #### Python
 ```python
-import os
-
 import geometamaker
 
-data_dir = 'C:/Users/dmf/projects/invest/data/invest-sample-data'
-geometamaker.describe_dir(data_dir, recursive=True)
+collection_path = 'invest/data/invest-sample-data'
+metadata = geometamaker.describe_collection(collection_path,
+                                            depth=2,
+                                            exclude_regex=r'.*\.json$',
+                                            describe_files=True)
+metadata.write()
 ```
 
 #### CLI
 ```
-geometamaker describe -r data/invest-sample-data
+geometamaker describe -d 2 --exclude .*\.json$ data/invest-sample-data
 ```
+These examples will create `invest-sample-data-metadata.yml` as well as
+create individual `.yml` documents for each dataset within the directory.
 
 ### Validating a metadata document:
 If you have manually edited a `.yml` metadata document,
@@ -328,7 +345,7 @@ print(error)
 geometamaker validate data/watershed_gura.shp.yml
 ```
 
-### Validating all metadata documents in a directory
+### Validating all metadata documents in a directory:
 
 ##### Python
 ```python
@@ -352,13 +369,10 @@ to all datasets they describe. Profiles can include `contact` information
 and/or `license` information.
 
 A profile can be saved to a configuration file so that it will be re-used
-everytime you use `geometamaker`. In addition, users can set a profile
-during runtime, which takes precedence over a profile in the config file.
+everytime you use `geometamaker`.
 
-#### Create & apply a Profile at runtime
+##### Python
 ```python
-import os
-
 import geometamaker
 from geometamaker import models
 
@@ -373,32 +387,11 @@ license = {
 profile = models.Profile(contact=contact)  # keyword arguments
 profile.set_license(**license)             # `set_*` methods
 
-data_path = 'data/watershed_gura.shp'
-# Pass the profile to the `describe` function
-resource = geometamaker.describe(data_path, profile=profile)
-```
-
-#### Store a Profile in user-configuration
-
-##### Python
-```python
-import os
-
-import geometamaker
-from geometamaker import models
-
-contact = {
-    'individual_name': 'bob'
-}
-
-profile = models.Profile(contact=contact)
 config = geometamaker.Config()
 config.save(profile)
 
-data_path = 'data/watershed_gura.shp'
-# A profile saved in the user's configuration file does not
-# need to be passed to `describe`. It is always applied.
-resource = geometamaker.describe(data_path)
+# The saved profile will automatically be applied during `describe`:
+resource = geometamaker.describe('data/watershed_gura.shp')
 ```
 
 ##### CLI
@@ -407,6 +400,3 @@ geometamaker config
 ```
 This will prompt the user to enter their profile information.  
 Also see `geometamaker config --help`.
-
-### For a complete list of methods:
-https://geometamaker.readthedocs.io/en/latest/api/geometamaker.html

geometamaker-0.2.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+geometamaker/__init__.py,sha256=fs8_0Wj-NfHHyK-wd5UHzMnCK2HxI0uWR_KtSbb8xXs,405
+geometamaker/cli.py,sha256=FGwrwBxJV269G509w2qvNNVbdMpxKHZv671M5ojeryE,10339
+geometamaker/config.py,sha256=KrDOFm_Wa15iZAmDxpy_yizBW3oIf0irqAVirFGWGLY,1964
+geometamaker/geometamaker.py,sha256=EuI1Nwgh6L1cNwNeyJhUm59JXWiqbc9XHKw7zpEWYLs,28344
+geometamaker/models.py,sha256=TF47XNKBhnSUScNXC3jk1Op_Icu7otLahApF3Kv0Hz0,27232
+geometamaker/utils.py,sha256=RLFtobLdUAeJEKBnzsQmC2h-eJTYn22tjNPAq261EhE,932
+geometamaker-0.2.0.dist-info/licenses/LICENSE.txt,sha256=Pd-b5cKP4n2tFDpdx27qJSIq0d1ok0oEcGTlbtL6QMU,11560
+geometamaker-0.2.0.dist-info/METADATA,sha256=-tSGY0ik9gLL_Lc0RpEf_RiPNRQoL41CP9MKZ53SrzE,19090
+geometamaker-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+geometamaker-0.2.0.dist-info/entry_points.txt,sha256=fY8nmpxmOO5kA47EBpKBKzaq3uZ1tWPA1sBgRJKvVU4,54
+geometamaker-0.2.0.dist-info/top_level.txt,sha256=cm34aKGvrHyEgqNXi3Cx9LTU1Sm79r1RkpQZpy9MoxA,13
+geometamaker-0.2.0.dist-info/RECORD,,

{geometamaker-0.1.2.dist-info → geometamaker-0.2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.8.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

geometamaker-0.1.2.dist-info/RECORD

@@ -1,12 +0,0 @@
-geometamaker/__init__.py,sha256=b3nR9UoJ7mWbD4z87B9BbrcnswpWEHgh9tC2SBvDYy4,391
-geometamaker/cli.py,sha256=87-ZDiReWuqyWPGkRMedJVWmIhcMC41TUtgiqqz6E1k,6277
-geometamaker/config.py,sha256=6xsBkU57QJlmehP0PcHL-f8Ev0KmYdrBrDb9IW5z99U,1974
-geometamaker/geometamaker.py,sha256=JQpsNXo7EU_J11aZnN1RSPufw7L3DDf_nAvoevPLRJA,18522
-geometamaker/models.py,sha256=aANY0vCKAz2gx4vIH0qnGicIhPXLTLZgXnByWOg-ER8,19054
-geometamaker/utils.py,sha256=RLFtobLdUAeJEKBnzsQmC2h-eJTYn22tjNPAq261EhE,932
-geometamaker-0.1.2.dist-info/LICENSE.txt,sha256=Pd-b5cKP4n2tFDpdx27qJSIq0d1ok0oEcGTlbtL6QMU,11560
-geometamaker-0.1.2.dist-info/METADATA,sha256=b2A4cOatxVrlv02MHxo66PrghdVgf5rx_rx_VxONIuI,18969
-geometamaker-0.1.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-geometamaker-0.1.2.dist-info/entry_points.txt,sha256=fY8nmpxmOO5kA47EBpKBKzaq3uZ1tWPA1sBgRJKvVU4,54
-geometamaker-0.1.2.dist-info/top_level.txt,sha256=cm34aKGvrHyEgqNXi3Cx9LTU1Sm79r1RkpQZpy9MoxA,13
-geometamaker-0.1.2.dist-info/RECORD,,