geometamaker 0.1.1__tar.gz → 0.2.0__tar.gz

geometamaker-0.2.0/HISTORY.rst

@@ -0,0 +1,66 @@
+Release History
+===============
+
+0.2.0 (2025-07-22)
+------------------
+* Allow CLI to ``describe`` remote datasets.
+  https://github.com/natcap/geometamaker/issues/78
+* Add support for describing tar gzip files in the same manner as zip
+  archives. https://github.com/natcap/geometamaker/issues/26
+* Metadata documents for raster and vector datasets now include metadata
+  key:value pairs that are defined on the GDAL raster, band, vector, and
+  layer objects. https://github.com/natcap/geometamaker/issues/68
+* Added an option to compute raster band statistics when calling ``describe``.
+  Statistics are included in the ``gdal_metadata`` section of metadata documents.
+  https://github.com/natcap/geometamaker/issues/77
+* Vector metadata documents now include a 'data_model.layers' section
+  for properties of the dataset that are specific to the layer.
+  Existing metadata documents can be migrated to this new schema by
+  calling ``describe`` on the vector dataset. GeoMetaMaker still only
+  supports describing metadata for the first layer in a vector dataset.
+  https://github.com/natcap/geometamaker/issues/28
+* Add support for describing folders as collections, generating a single
+  metadata file listing contained files along with their descriptions and
+  metadata. https://github.com/natcap/geometamaker/issues/66
+* ``describe_dir`` has been deprecated as this functionality can be achieved
+  with ``describe_collection``. https://github.com/natcap/geometamaker/issues/98
+* Existing attributes are now preserved when calling
+  ``describe_collection`` on collection with existing metadata.
+  https://github.com/natcap/geometamaker/issues/95
+* Removed the ``profile`` argument to ``describe``. ``set_contact`` and
+  ``set_license`` can still be used to set those metadata properties.
+  ``Config`` can still be used to create and store a default profile.
+  https://github.com/natcap/geometamaker/issues/92
+* If an invalid metadata document exists when a dataset or collection is
+  described, do not prevent creation of a new metadata document.
+  Invalid/incompatible documents will be renamed by adding a '.bak' extension
+  before the new metadata document replaces them.
+  https://github.com/natcap/geometamaker/issues/89
+* ``geometamaker describe``, when given a directory, will create a
+  "-metadata.yml" document for that directory, as well as metadata documents
+  for all datasets within.
+  https://github.com/natcap/geometamaker/issues/94
+* ``geometamaker.validate_dir`` was updated to use the ``depth`` argument
+  instead of ``recursive``.
+* If ``describe`` is called on a directory, a helpful error message is raised.
+  https://github.com/natcap/geometamaker/issues/98
+
+
+0.1.2 (2025-02-05)
+------------------
+* Declared dependencies in ``pyproject.toml`` to facilitate pip installs.
+
+0.1.1 (2025-02-04)
+------------------
+* Fixed a bug where rasters without a defined nodata value could not be
+  described. https://github.com/natcap/geometamaker/issues/70
+* All YAML documents will be written as UTF-8 encoded files.
+  https://github.com/natcap/geometamaker/issues/71
+* Fixed a bug in formatting of validation messages about nested attributes
+  https://github.com/natcap/geometamaker/issues/65
+* Added exception handling to make validating directories more resilient to
+  unreadable yaml files. https://github.com/natcap/geometamaker/issues/62
+
+0.1.0 (2025-01-10)
+------------------
+* First release!

{geometamaker-0.1.1 → geometamaker-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: geometamaker
-Version: 0.1.1
+Version: 0.2.0
 Summary: metadata creation for geospatial data
 Maintainer: Natural Capital Project Software Team
 License: 
@@ -225,16 +225,34 @@ Classifier: Topic :: Scientific/Engineering :: GIS
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE.txt
-
-A Python library for creating human and machine-readable metadata for geospatial data.
+Requires-Dist: aiohttp
+Requires-Dist: click
+Requires-Dist: fsspec
+Requires-Dist: GDAL
+Requires-Dist: frictionless>=5.10.0
+Requires-Dist: numpy
+Requires-Dist: platformdirs
+Requires-Dist: Pydantic>=2.0
+Requires-Dist: pygeoprocessing>=2.4.5
+Requires-Dist: pyyaml
+Requires-Dist: requests
+Dynamic: license-file
+
+## 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
@@ -271,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
 ```
@@ -282,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,
@@ -317,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
@@ -341,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
 
@@ -362,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
@@ -396,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.1.1 → geometamaker-0.2.0}/README.md

@@ -1,12 +1,18 @@
-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
@@ -43,6 +49,8 @@ resource.set_band_description(
 
 resource.write()
 ```
+For a complete list of methods and attributes:
+https://geometamaker.readthedocs.io/en/latest/index.html
 
 ##### CLI
 ```
@@ -54,22 +62,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,
@@ -89,7 +105,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
@@ -113,13 +129,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
 
@@ -134,32 +147,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
@@ -168,6 +160,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.1.1 → geometamaker-0.2.0}/docs/environment-rtd.yml

@@ -9,6 +9,7 @@ channels:
     - conda-forge
 dependencies:
     - python=3.10
+    - pip
     - frictionless
     - fsspec
     - gdal>=3
@@ -16,3 +17,6 @@ dependencies:
     - pygeoprocessing>=2.4.2
     - pyyaml
     - sphinx_rtd_theme
+    - myst-parser
+    - pip:
+        - autodoc_pydantic

geometamaker-0.2.0/docs/source/archive_resource.rst

@@ -0,0 +1,6 @@
+Archive Resource
+================
+.. autopydantic_model:: geometamaker.models.ArchiveResource
+    :inherited-members: BaseModel
+    :model-show-json: True
+    :no-index:

geometamaker-0.2.0/docs/source/basic_usage.rst

@@ -0,0 +1,5 @@
+Basic Usage
+===========
+.. include:: ../../README.md
+   :parser: myst_parser.sphinx_
+   :start-after: Basic Usage

geometamaker-0.2.0/docs/source/collection_resource.rst

@@ -0,0 +1,6 @@
+Collection Resource
+===============
+.. autopydantic_model:: geometamaker.models.CollectionResource
+    :inherited-members: BaseModel
+    :model-show-json: True
+    :no-index:

{geometamaker-0.1.1 → geometamaker-0.2.0}/docs/source/conf.py

@@ -26,6 +26,8 @@ extensions = [
     'sphinx.ext.viewcode',
     'sphinx.ext.napoleon',  # support google style docstrings
     'sphinx.ext.autosummary',
+    'sphinxcontrib.autodoc_pydantic',
+    'myst_parser',
 ]
 
 templates_path = ['_templates']
@@ -46,6 +48,29 @@ html_static_path = ['_static']
 nitpicky = False
 autoclass_content = 'both'
 
+autodoc_pydantic_model_show_json = False
+autodoc_pydantic_model_show_config_summary = False
+autodoc_pydantic_model_show_field_summary = False
+
+
+def setup(app):
+    app.connect('autodoc-process-docstring',
+                process_module_specific_docstrings)
+
+
+def process_module_specific_docstrings(app, what, name, obj, options, lines):
+    """Strip inherited __init__ docstring from Pydantic models.
+
+    Remove the __init__ docstring content because
+    Pydantic models generate their own __init__ from the parent.
+    So `autodoc_inherit_docstrings = False` will not do the job.
+
+    """
+    if what == "pydantic_model":
+        if hasattr(obj, "__init__") and obj.__init__.__doc__:
+            obj.__init__.__doc__ = None
+
+
 DOCS_SOURCE_DIR = os.path.dirname(__file__)
 sphinx.ext.apidoc.main([
     '--force',

{geometamaker-0.1.1 → geometamaker-0.2.0}/docs/source/index.rst

@@ -4,7 +4,21 @@
    contain the root `toctree` directive.
 
 GeoMetaMaker
-========================================
+============
+
+Release: |release|
+
+GeoMetaMaker is a Python library for creating human and machine-readable
+metadata for geospatial, tabular, and other data formats.
+
+GeoMetaMaker is developed by the `Natural Capital Project <https://naturalcapitalproject.stanford.edu>`_.
+
+.. toctree::
+   :maxdepth: 1
+
+   installation
+   basic_usage
+   metadata_resources
 
 .. toctree::
    :maxdepth: 1

geometamaker-0.2.0/docs/source/installation.rst

@@ -0,0 +1,25 @@
+Installation
+============
+
+Suggested Method: ``conda-forge``
+---------------------------------
+
+The easiest way to install ``geometamaker`` is using the
+`conda <https://docs.conda.io/en/latest/miniconda.html>`_ or
+`mamba <https://mamba.readthedocs.io/en/latest/installation.html>`_ package managers::
+
+    mamba install -c conda-forge geometamaker
+
+If you prefer to use ``conda``, the command is otherwise the same::
+
+    conda install -c conda-forge geometamaker
+
+Dependencies
+------------
+
+Dependencies for ``geometamaker`` are listed in ``requirements.txt`` and
+included here for your reference. Your package manager should, under most
+circumstances, handle the dependency resolution for you.
+
+.. include:: ../../requirements.txt
+    :literal:

geometamaker-0.2.0/docs/source/metadata_resources.rst

@@ -0,0 +1,11 @@
+Metadata Resource Models
+========================
+.. toctree::
+   :maxdepth: 1
+
+   raster_resource
+   vector_resource
+   table_resource
+   archive_resource
+   collection_resource
+   profile

geometamaker-0.2.0/docs/source/profile.rst

@@ -0,0 +1,6 @@
+Profile
+=======
+.. autopydantic_model:: geometamaker.models.Profile
+    :inherited-members: BaseModel
+    :model-show-json: True
+    :no-index:

geometamaker-0.2.0/docs/source/raster_resource.rst

@@ -0,0 +1,6 @@
+Raster Resource
+===============
+.. autopydantic_model:: geometamaker.models.RasterResource
+    :inherited-members: BaseModel
+    :model-show-json: True
+    :no-index:

geometamaker-0.2.0/docs/source/table_resource.rst

@@ -0,0 +1,6 @@
+Table Resource
+==============
+.. autopydantic_model:: geometamaker.models.TableResource
+    :inherited-members: BaseModel
+    :model-show-json: True
+    :no-index:

geometamaker-0.2.0/docs/source/vector_resource.rst

@@ -0,0 +1,6 @@
+Vector Resource
+===============
+.. autopydantic_model:: geometamaker.models.VectorResource
+    :inherited-members: BaseModel
+    :model-show-json: True
+    :no-index:

{geometamaker-0.1.1 → geometamaker-0.2.0}/pyproject.toml

@@ -30,6 +30,9 @@ classifiers = [
 # using the corresponding setup args `install_requires` and `extras_require`
 dynamic = ["version", "dependencies", "optional-dependencies"]
 
+[tool.setuptools.dynamic]
+dependencies = {file = ["requirements.txt"]}
+
 [tool.setuptools_scm]
 version_scheme = "post-release"
 local_scheme = "node-and-date"

{geometamaker-0.1.1 → geometamaker-0.2.0}/src/geometamaker/__init__.py

@@ -1,7 +1,7 @@
 import importlib.metadata
 
 from .geometamaker import describe
-from .geometamaker import describe_dir
+from .geometamaker import describe_collection
 from .geometamaker import validate
 from .geometamaker import validate_dir
 from .config import Config
@@ -10,4 +10,4 @@ from .models import Profile
 
 __version__ = importlib.metadata.version('geometamaker')
 
-__all__ = ('describe', 'describe_dir', 'validate', 'validate_dir', 'Config', 'Profile')
+__all__ = ('describe', 'describe_collection', 'validate', 'validate_dir', 'Config', 'Profile')