Skip to main content

CLI utility to read/write XMP fields in files

Project description Latest Version Downloads

This is a simple command line utility to read/write single value fields in XMP files using the python-xmp-toolkit.


A simple install from pip:

$ pip install xmp-tool
Note: python-xmp-toolkit depends on Exempi which needs to be
built for XMP to be installed properly.

Use your systems package manager to install Exempi, on Mac OS X with homebrew:

$ brew install exempi

On a Debian based Linux system do:

# apt-get install libexempi-dev


$ xmp-tool -h
usage: xmp-tool [-h] [--value VALUE] [--no-sidecar] [field] file [file ...]

Read or write XMP fields in a file

positional arguments:
  field          The field to read/write. If no field specified entire XMP
                 document printed.
  file           A file to work on

optional arguments:
  -h, --help     show this help message and exit
  --value VALUE  A value to write to the field specified
  --no-sidecar   Never write to sidecar files.

Reading a field:

$ xmp-tool format test.jpg
test.jpg: format=image/jpeg

Reading the entire XMP contents of a file:

$ xmp-tool test.jpg
test.jpg: None=<?xpacket begin="" id="W5M0MpCehiHzreSzNTczkc9d"?>
<x:xmpmeta xmlns:x="adobe:ns:meta/" x:xmptk="Exempi + XMP Core 5.1.2">
 <rdf:RDF xmlns:rdf="">
  <rdf:Description rdf:about=""
<?xpacket end="w"?>

Writing a field:

# First try to read the field when there's no data in it
$ xmp-tool PhysicalMedium test.jpg
test.jpeg: ERROR READING FIELD "PhysicalMedium"

# Then try to add the data and then read the field
$ xmp-tool PhysicalMedium --value lto01 test.jpg
$ xmp-tool PhysicalMedium test.jpg
test.jpg: PhysicalMedium=lto01

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for xmp-tool, version 0.9.2
Filename, size File type Python version Upload date Hashes
Filename, size xmp_tool-0.9.2-py2.py3-none-any.whl (6.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size xmp-tool-0.9.2.tar.gz (4.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page