Naturtag

A tool for nature photographers that adds useful metadata to describe the organisms in your photos.
https://github.com/pyinat/naturtag

biodiversity biodiversity-data cli darwin-core dwc exif hierarchical-keywords inaturalist iptc photography taxonomy xmp

Last synced: about 19 hours ago
JSON representation

Repository metadata

Tag your nature photos with iNat taxonomy and observation metadata

• Host: GitHub
• URL: https://github.com/pyinat/naturtag
• Owner: pyinat
• License: mit
• Created: 2020-05-10T18:52:49.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-05-06T21:03:58.000Z (5 days ago)
• Last Synced: 2024-05-08T06:05:13.755Z (4 days ago)
• Topics: biodiversity, biodiversity-data, cli, darwin-core, dwc, exif, hierarchical-keywords, inaturalist, iptc, photography, taxonomy, xmp
• Language: Python
• Homepage: https://naturtag.readthedocs.io
• Size: 86.9 MB
• Stars: 36
• Watchers: 3
• Forks: 4
• Open Issues: 61
• Metadata Files:
  • Readme: README.md
  • Changelog: HISTORY.md
  • License: LICENSE

README

        
# Naturtag

[![Build status](https://github.com/pyinat/naturtag/workflows/Test/badge.svg?branch=main)](https://github.com/pyinat/naturtag/actions)

[![Documentation Status](https://readthedocs.org/projects/naturtag/badge/?version=stable)](https://naturtag.readthedocs.io/en/stable/)

[![GitHub issues](https://img.shields.io/github/issues/pyinat/naturtag)](https://github.com/pyinat/naturtag/issues)

[![PyPI](https://img.shields.io/pypi/v/naturtag?color=blue)](https://pypi.org/project/naturtag)

[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/naturtag)](https://pypi.org/project/naturtag)




[![](assets/icons/naturtag-gh-preview.png)](https://naturtag.readthedocs.io)

## Contents

- [Summary](#summary)

- [Use Cases](#use-cases)

- [Installation](#installation)

- [Usage](#usage)

  - [GUI](#gui)

  - [CLI](#cli)

  - [Library](#library)

- [Development Status](#development-status)

## Summary

Naturtag is a tool for nature photographers that adds useful metadata to describe the organisms in

your photos. It includes a **desktop application**, a **command-line interface**, and can also be

used as a **python library**. It is mainly intended for use with [iNaturalist](https://www.inaturalist.org), but can also be used independently.

Naturtag gathers complete observation metadata (for iNaturalist observation photos), or just taxonomy metadata (for everything else). It then embeds this information in your local photo collection using

[XMP](https://en.wikipedia.org/wiki/Extensible_Metadata_Platform) and

[EXIF](https://en.wikipedia.org/wiki/Exif) metadata.

## Use Cases

This image metadata has a variety of uses, including:

### Local photo organization

Naturtag can tag your photos with **hierarchical keywords** (aka structured keywords), which

are supported by some photo viewers/editors like

[**Lightroom**](https://millennialdiyer.com/articles/photography/lightroom-keyword-hierarchy/),

[**FastPictureViewer**](https://www.fastpictureviewer.com),

[**Photo Mechanic**](https://www.photometadata.org/META-Tutorials-Photo-Mechanic-Applying-Keywords),

[**digiKam**](https://www.digikam.org), and

[**XnViewMP**](https://www.xnview.com/en/xnviewmp).

This basically gives you a taxonomic tree for browsing and filtering your photos.

Example in XnView

![screenshot](assets/screenshots/xnview.png)

### Photo hosting

Naturtag can also simplify tagging photos for photo hosting sites like Flickr. For that use case, this

tool generates semi-structured keywords in the same format as

[iNaturalist's Flickr Tagger](https://www.inaturalist.org/taxa/flickr_tagger).

Example search using these tags: https://www.flickr.com/photos/tags/taxonomy:class=arachnida

Example of taxonomy tags on Flickr

![screenshot](assets/screenshots/flickr.png)

### Other biodiversity tools

Finally, naturtag can improve interoperability with other tools and systems that interact with biodiversity

data. For example, in addition to iNaturalist you might submit some observations to another

platform with a more specific focus, such as **eBird**, **BugGuide**, or **Mushroom Observer**.

For that use case, this tool supports [Simple Darwin Core](https://dwc.tdwg.org/simple).

## Installation

See [GitHub Releases](https://github.com/pyinat/naturtag/releases) for downloads and

[Installation](https://naturtag.readthedocs.io/en/stable/installation.html)

for platform-specific instructions.

To just install naturtag as a python package, run:

```bash

pip install naturtag

```

## Usage

### GUI

The main interface for this project is still a work in progress.

It includes an interface for selecting and tagging images:

![Screenshot](assets/screenshots/image-selector.png)

And tools to search and browse species to tag your images with:

![Screenshot](assets/screenshots/taxon-search.png)

See [Application Guide](https://naturtag.readthedocs.io/en/stable/app.html) for more details.

### CLI

Naturtag also includes a command-line interface. It takes an observation or species, plus some image

files, and generates EXIF and XMP metadata to write to those images. You can see it in action here:

[![asciicast](https://asciinema.org/a/0a6gzpt7AI9QpGoq0OGMDOxqi.svg)](https://asciinema.org/a/0a6gzpt7AI9QpGoq0OGMDOxqi)

See [CLI documentation](https://naturtag.readthedocs.io/en/stable/cli.html) for more details.

### Library

You can also import `naturtag` as a python library, and use its main features in your own scripts or

applications. Basic example:

```python

from naturtag import tag_images, refresh_tags

# Tag images with full observation metadata

tag_images(['img1.jpg', 'img2.jpg'], observation_id=1234)

# Refresh previously tagged images with latest observation and taxonomy metadata

refresh_tags(['~/observations/'], recursive=True)

```

See [API Reference](https://naturtag.readthedocs.io/en/stable/reference.html) for more details.

## Development Status

* See [Issues](https://github.com/pyinat/naturtag/issues) for planned features and current progress.

* If you have any problems, suggestions, or questions about naturtag, you can:

  * [Create an issue](https://github.com/pyinat/naturtag/issues/new/choose)

  * [Create a discussion](https://github.com/orgs/pyinat/discussions)

  * Ping me (**@jcook**) on the [iNaturalist Community Forum](https://forum.inaturalist.org/c/general/14).

* When I'm not working on this, I'm often working on other libraries that naturtag benefits from, including

  [pyinaturalist](https://pyinaturalist.readthedocs.io),

  [pyinaturalist-convert](https://github.com/pyinat/pyinaturalist-convert), and

  [requests-cache](https://requests-cache.readthedocs.io).

      

---

Owner metadata

• Name: pyinat
• Login: pyinat
• Email:
• Kind: organization
• Description: Python tools for interacting with iNaturalist
• Website: https://pyinaturalist.readthedocs.io
• Location:
• Twitter:
• Company:
• Icon url: https://avatars.githubusercontent.com/u/105503620?v=4
• Repositories: 6
• Last ynced at: 2023-03-04T09:47:16.609Z
• Profile URL: https://github.com/pyinat

---

GitHub Events

Total

• Create event: 138
• Release event: 6
• Issues event: 162
• Watch event: 28
• Delete event: 126
• Issue comment event: 96
• Push event: 549
• Pull request event: 248
• Fork event: 3

Last Year

• Create event: 52
• Delete event: 48
• Fork event: 1
• Issue comment event: 40
• Issues event: 14
• Pull request event: 101
• Push event: 129
• Release event: 1
• Watch event: 9

---

Committers metadata

Last synced: 2 days ago

Name	Email	Commits
Jordan Cook	j****k@p****m	544
Jordan Cook	J****k@p****m	4
dependabot[bot]	4****]	4
Kian-Meng Ang	k****g@c****g	1

Committer domains:

• pioneer.com: 2
• cpan.org: 1

---

Issue and Pull Request metadata

Last synced: 2 days ago

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/pyinat/naturtag

---

---

---

Dependencies

Score: 5.961005339623274