naturtag.metadata.inat_metadata module#

Tools to translate iNaturalist observations and taxa into image metadata

naturtag.metadata.inat_metadata.observation_to_metadata(observation, metadata=None, common_names=False, hierarchical=False)#

Get image metadata from an Observation object

Return type:

MetaMetadata

naturtag.metadata.inat_metadata.refresh_tags(image_paths, recursive=False, client=None, settings=None)#

Refresh metadata for previously tagged images with latest observation and/or taxon data.

Example

>>> # Refresh previously tagged images with latest observation and taxonomy metadata
>>> from naturtag import refresh_tags
>>> refresh_tags(['~/observations/'], recursive=True)
Parameters:

  • image_paths (Iterable[Union[Path, str]]) – Paths to images to tag

  • recursive (bool) – Recursively search subdirectories for valid image files

  • settings (Optional[Settings]) – Settings for metadata types to generate

Return type:

list[MetaMetadata]

Returns:

Updated metadata objects for updated images only

naturtag.metadata.inat_metadata.tag_images(image_paths, observation_id=None, taxon_id=None, recursive=False, include_sidecars=False, client=None, settings=None)#

Get taxonomy tags from an iNaturalist observation or taxon, and write them to local image metadata.

Examples

>>> # Tag images with full observation metadata:
>>> from naturtag import tag_images
>>> tag_images(['img1.jpg', 'img2.jpg'], observation_id=1234)

>>> # Tag images with taxonomy metadata only
>>> tag_images(['img1.jpg', 'img2.jpg'], taxon_id=1234)

>>> # Glob patterns are also supported
>>> tag_images(['~/observations/*.jpg'], taxon_id=1234)
Parameters:

  • image_paths (Iterable[Union[Path, str]]) – Paths to images to tag

  • observation_id (Optional[int]) – ID of an iNaturalist observation

  • taxon_id (Optional[int]) – ID of an iNaturalist species or other taxon

  • recursive (bool) – Recursively search subdirectories for valid image files

  • include_sidecars (bool) – Allow loading a sidecar file without an associated image

  • settings (Optional[Settings]) – Settings for metadata types to generate

Return type:

list[MetaMetadata]

Returns:

Updated image metadata for each image