From c11afbaa6ef3b3ebc4e1637c7e83b1b5e036f9ef Mon Sep 17 00:00:00 2001 From: Rhet Turnbull Date: Sat, 14 Mar 2020 20:54:53 -0700 Subject: [PATCH] Updated docs --- README.md | 2 +- osxphotos/photoinfo.py | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 11c3b82f..349fe8eb 100644 --- a/README.md +++ b/README.md @@ -715,7 +715,7 @@ Returns a JSON representation of all photo info Export photo from the Photos library to another destination on disk. - dest: must be valid destination path as str (or exception raised). -- *filename (optional): name of picture as str; if not provided, will use current filename +- *filename (optional): name of picture as str; if not provided, will use current filename. **NOTE**: if provided, user must ensure file extension (suffix) is correct. For example, if photo is .CR2 file, edited image may be .jpeg. If you provide an extension different than what the actual file is, export will print a warning but will happily export the photo using the incorrect file extension. e.g. to get the extension of the edited photo, look at [PhotoInfo.path_edited](#path_edited). - edited: boolean; if True (default=False), will export the edited version of the photo (or raise exception if no edited version) - overwrite: boolean; if True (default=False), will overwrite files if they alreay exist - live_photo: boolean; if True (default=False), will also export the associted .mov for live photos; exported live photo will be named filename.mov diff --git a/osxphotos/photoinfo.py b/osxphotos/photoinfo.py index adf18df4..84065c84 100644 --- a/osxphotos/photoinfo.py +++ b/osxphotos/photoinfo.py @@ -506,6 +506,12 @@ class PhotoInfo: """ export photo dest: must be valid destination path (or exception raised) filename: (optional): name of picture; if not provided, will use current filename + **NOTE**: if provided, user must ensure file extension (suffix) is correct. + For example, if photo is .CR2 file, edited image may be .jpeg. + If you provide an extension different than what the actual file is, + export will print a warning but will happily export the photo using the + incorrect file extension. e.g. to get the extension of the edited photo, + reference PhotoInfo.path_edited edited: (boolean, default=False); if True will export the edited version of the photo (or raise exception if no edited version) live_photo: (boolean, default=False); if True, will also export the associted .mov for live photos