Updated README.md

This commit is contained in:
Rhet Turnbull
2020-01-20 08:02:03 -08:00
parent d1afd55a7c
commit 0aff83ff21

160
README.md
View File

@@ -84,79 +84,93 @@ Usage: osxphotos export [OPTIONS] [PHOTOS_LIBRARY]... DEST
photos will be exported. photos will be exported.
Options: Options:
--db <Photos database path> Specify Photos database path. --db <Photos database path> Specify Photos database path. Path to Photos
--keyword TEXT Search for keyword(s). library/database can be specified using
--person TEXT Search for person(s). either --db or directly as PHOTOS_LIBRARY
--album TEXT Search for album(s). positional argument.
--uuid TEXT Search for UUID(s). --keyword TEXT Search for keyword(s).
--title TEXT Search for TEXT in title of photo. --person TEXT Search for person(s).
--no-title Search for photos with no title. --album TEXT Search for album(s).
--description TEXT Search for TEXT in description of photo. --uuid TEXT Search for UUID(s).
--no-description Search for photos with no description. --title TEXT Search for TEXT in title of photo.
--uti TEXT Search for photos whose uniform type identifier --no-title Search for photos with no title.
(UTI) matches TEXT --description TEXT Search for TEXT in description of photo.
-i, --ignore-case Case insensitive search for title or --no-description Search for photos with no description.
description. Does not apply to keyword, person, --uti TEXT Search for photos whose uniform type
or album. identifier (UTI) matches TEXT
--edited Search for photos that have been edited. -i, --ignore-case Case insensitive search for title or
--external-edit Search for photos edited in external editor. description. Does not apply to keyword,
--favorite Search for photos marked favorite. person, or album.
--not-favorite Search for photos not marked favorite. --edited Search for photos that have been edited.
--hidden Search for photos marked hidden. --external-edit Search for photos edited in external editor.
--not-hidden Search for photos not marked hidden. --favorite Search for photos marked favorite.
--burst Search for photos that were taken in a burst. --not-favorite Search for photos not marked favorite.
--not-burst Search for photos that are not part of a burst. --hidden Search for photos marked hidden.
--live Search for Apple live photos --not-hidden Search for photos not marked hidden.
--not-live Search for photos that are not Apple live --shared Search for photos in shared iCloud album
photos (Photos 5 only).
--shared Search for photos in shared iCloud album --not-shared Search for photos not in shared iCloud album
(Photos 5 only). (Photos 5 only).
--not-shared Search for photos not in shared iCloud album --burst Search for photos that were taken in a
(Photos 5 only). burst.
-V, --verbose Print verbose output. --not-burst Search for photos that are not part of a
--overwrite Overwrite existing files. Default behavior is burst.
to add (1), (2), etc to filename if file --live Search for Apple live photos
already exists. Use this with caution as it may --not-live Search for photos that are not Apple live
create name collisions on export. (e.g. if two photos
files happen to have the same name) --only-movies Search only for movies (default searches
--export-by-date Automatically create output folders to organize both images and movies).
photos by date created (e.g. --only-photos Search only for photos/images (default
DEST/2019/12/20/photoname.jpg). searches both images and movies).
--export-edited Also export edited version of photo if an --from-date [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]
edited version exists. Edited photo will be Search by start item date, e.g.
named in form of "photoname_edited.ext" 2000-01-12T12:00:00 or 2000-12-31 (ISO 8601
--export-bursts If a photo is a burst photo export all w/o TZ).
associated burst images in the library. --to-date [%Y-%m-%d|%Y-%m-%dT%H:%M:%S|%Y-%m-%d %H:%M:%S]
--export-live If a photo is a live photo export the Search by end item date, e.g.
associated live video component. Live video 2000-01-12T12:00:00 or 2000-12-31 (ISO 8601
will have same name as photo but with .mov w/o TZ).
extension. -V, --verbose Print verbose output.
--original-name Use photo's original filename instead of --overwrite Overwrite existing files. Default behavior
current filename for export. is to add (1), (2), etc to filename if file
--sidecar Create JSON sidecar for each photo exported in already exists. Use this with caution as it
format useable by exiftool may create name collisions on export. (e.g.
(https://exiftool.org/) The sidecar file can be if two files happen to have the same name)
used to apply metadata to the file with --export-by-date Automatically create output folders to
exiftool, for example: "exiftool organize photos by date created (e.g.
-j=photoname.jpg.json photoname.jpg" The DEST/2019/12/20/photoname.jpg).
sidecar file is named in format --export-edited Also export edited version of photo if an
photoname.ext.json where ext is extension of edited version exists. Edited photo will be
the photo (e.g. jpg). Note: this does not named in form of "photoname_edited.ext"
create an XMP sidecar as used by Lightroom, --export-bursts If a photo is a burst photo export all
etc. associated burst images in the library.
--only-movies Search only for movies (default searches both --export-live If a photo is a live photo export the
images and movies). associated live video component. Live video
--only-photos Search only for photos/images (default searches will have same name as photo but with .mov
both images and movies). extension.
--download-missing Attempt to download missing photos from iCloud. --original-name Use photo's original filename instead of
The current implementation uses Applescript to current filename for export.
interact with Photos to export the photo which --sidecar Create JSON sidecar for each photo exported
will force Photos to download from iCloud if in format useable by exiftool
the photo does not exist on disk. This will be (https://exiftool.org/) The sidecar file can
slow and will require internet connection. This be used to apply metadata to the file with
obviously only works if the Photos library is exiftool, for example: "exiftool
synched to iCloud. -j=photoname.jpg.json photoname.jpg" The
-h, --help Show this message and exit. sidecar file is named in format
photoname.ext.json where ext is extension of
the photo (e.g. jpg). Note: this does not
create an XMP sidecar as used by Lightroom,
etc.
--download-missing Attempt to download missing photos from
iCloud. The current implementation uses
Applescript to interact with Photos to
export the photo which will force Photos to
download from iCloud if the photo does not
exist on disk. This will be slow and will
require internet connection. This obviously
only works if the Photos library is synched
to iCloud.
-h, --help Show this message and exit.
``` ```
Example: export all photos to ~/Desktop/export, including edited versions and live photo movies, group in folders by date created Example: export all photos to ~/Desktop/export, including edited versions and live photo movies, group in folders by date created