Upgraded osxmetadata to add new extended attributes

CHANGELOG.md

@@ -4,6 +4,21 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+#### [v0.42.61](https://github.com/RhetTbull/osxphotos/compare/v0.42.60...v0.42.61)
+
+> 7 July 2021
+
+- Added --selected, closes #489 [`#489`](https://github.com/RhetTbull/osxphotos/issues/489)
+
+#### [v0.42.60](https://github.com/RhetTbull/osxphotos/compare/v0.42.59...v0.42.60)
+
+> 6 July 2021
+
+- docs: add mkirkland4874 as a contributor for example [`#492`](https://github.com/RhetTbull/osxphotos/pull/492)
+- Updated README.md [skip ci], closes #488 [`#488`](https://github.com/RhetTbull/osxphotos/issues/488)
+- Added example for {function} template [`016297d`](https://github.com/RhetTbull/osxphotos/commit/016297d2ffcf2e8db0d659ccfe7411ecff3dd41b)
+- Fixed cleanup to delete empty folders, #491 [`1bf11b0`](https://github.com/RhetTbull/osxphotos/commit/1bf11b0414a7fcf785c792b98f6231821bdad4d4)
+
 #### [v0.42.59](https://github.com/RhetTbull/osxphotos/compare/v0.42.58...v0.42.59)
 
 > 4 July 2021

README.md

@@ -3,6 +3,7 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 [![tests](https://github.com/RhetTbull/osxphotos/workflows/Tests/badge.svg)](https://github.com/RhetTbull/osxphotos/workflows/Tests/badge.svg)
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/osxphotos)
+[![Downloads](https://static.pepy.tech/personalized-badge/osxphotos?period=month&units=international_system&left_color=black&right_color=brightgreen&left_text=downloads/month)](https://pepy.tech/project/osxphotos)
 [![All Contributors](https://img.shields.io/badge/all_contributors-25-orange.svg?style=flat)](#contributors)
 
 OSXPhotos provides the ability to interact with and query Apple's Photos.app library on macOS. You can query the Photos library database — for example, file name, file path, and metadata such as keywords/tags, persons/faces, albums, etc. You can also easily export both the original and edited photos.
@@ -409,6 +410,12 @@ To export only photos contained in the album "Summer Vacation":
 
 `osxphotos export /path/to/export --album "Summer Vacation"`
 
+In Photos, it's possible to have multiple albums with the same name. In this case, osxphotos would export photos from all albums matching the value passed to `--album`.  If you wanted to export only one of the albums and this album is in a folder, the `--regex` option (short for "regular expression"), which does pattern matching, could be used with the `{folder_album}` template to match the specific album.  For example, if you had a "Summer Vacation" album inside the folder "2018" and also one with the same name inside the folder "2019", you could export just the album "2018/Summer Vacation" using this command:
+
+`osxphotos export /path/to/export --regex "2018/Summer Vacation" "{folder_album}"`
+
+This command matches the pattern "2018/Summer Vacation" against the full folder/album path for every photo.
+
 There are also a number of query options to export only certain types of photos.  For example, to export only photos taken with iPhone "Portrait Mode":
 
 `osxphotos export /path/to/export --portrait`
@@ -753,6 +760,9 @@ Options:
                                   more than one regular expression match by
                                   repeating '--regex' with different arguments.
 
+  --selected                      Filter for photos that are currently selected
+                                  in Photos.
+
   --query-eval CRITERIA           Evaluate CRITERIA to filter photos. CRITERIA
                                   will be evaluated in context of the following
                                   python list comprehension: `photos = [photo
@@ -1776,7 +1786,7 @@ Substitution                    Description
 {lf}                            A line feed: '\n', alias for {newline}
 {cr}                            A carriage return: '\r'
 {crlf}                          a carriage return + line feed: '\r\n'
-{osxphotos_version}             The osxphotos version, e.g. '0.42.59'
+{osxphotos_version}             The osxphotos version, e.g. '0.42.61'
 {osxphotos_cmd_line}            The full command line used to run osxphotos
 
 The following substitutions may result in multiple values. Thus if specified for
@@ -3608,7 +3618,7 @@ The following template field substitutions are availabe for use the templating s
 |{lf}|A line feed: '\n', alias for {newline}|
 |{cr}|A carriage return: '\r'|
 |{crlf}|a carriage return + line feed: '\r\n'|
-|{osxphotos_version}|The osxphotos version, e.g. '0.42.59'|
+|{osxphotos_version}|The osxphotos version, e.g. '0.42.61'|
 |{osxphotos_cmd_line}|The full command line used to run osxphotos|
 |{album}|Album(s) photo is contained in|
 |{folder_album}|Folder path + album photo is contained in. e.g. 'Folder/Subfolder/Album' or just 'Album' if no enclosing folder|

osxphotos/_constants.py

@@ -227,10 +227,17 @@ EXTENDED_ATTRIBUTE_NAMES = [
     "authors",
     "comment",
     "copyright",
+    "creator",
     "description",
     "findercomment",
     "headline",
     "keywords",
+    "participants",
+    "projects",
+    "rating",
+    "subject",
+    "title",
+    "version",
 ]
 EXTENDED_ATTRIBUTE_NAMES_QUOTED = [f"'{x}'" for x in EXTENDED_ATTRIBUTE_NAMES]
 

osxphotos/_version.py

@@ -1,3 +1,3 @@
 """ version info """
 
-__version__ = "0.42.60"
+__version__ = "0.42.62"

osxphotos/cli.py

@@ -536,6 +536,11 @@ def QUERY_OPTIONS(f):
             "For example, to find photos in an album that begins with 'Beach': '--regex \"^Beach\" \"{album}\"'. "
             "You may specify more than one regular expression match by repeating '--regex' with different arguments.",
         ),
+        o(
+            "--selected",
+            is_flag=True,
+            help="Filter for photos that are currently selected in Photos.",
+        ),
         o(
             "--query-eval",
             metavar="CRITERIA",
@@ -1182,6 +1187,7 @@ def export(
     min_size,
     max_size,
     regex,
+    selected,
     query_eval,
     query_function,
     duplicate,
@@ -1345,6 +1351,7 @@ def export(
         min_size = cfg.min_size
         max_size = cfg.max_size
         regex = cfg.regex
+        selected = cfg.selected
         query_eval = cfg.query_eval
         query_function = cfg.query_function
         duplicate = cfg.duplicate
@@ -1663,6 +1670,7 @@ def export(
         min_size=min_size,
         max_size=max_size,
         regex=regex,
+        selected=selected,
         query_eval=query_eval,
         function=query_function,
         duplicate=duplicate,
@@ -2071,6 +2079,7 @@ def query(
     min_size,
     max_size,
     regex,
+    selected,
     query_eval,
     query_function,
     add_to_album,
@@ -2105,6 +2114,7 @@ def query(
         min_size,
         max_size,
         regex,
+        selected,
         duplicate,
     ]
     exclusive = [
@@ -2235,6 +2245,7 @@ def query(
         query_eval=query_eval,
         function=query_function,
         regex=regex,
+        selected=selected,
         duplicate=duplicate,
     )
 

osxphotos/photosdb/photosdb.py

@@ -17,6 +17,7 @@ from pprint import pformat
 from typing import List
 
 import bitmath
+import photoscript
 
 from .._constants import (
     _DB_TABLE_NAMES,
@@ -3324,6 +3325,18 @@ class PhotosDB:
         elif options.no_location:
             photos = [p for p in photos if p.location == (None, None)]
 
+        if options.selected:
+            # photos selected in Photos app
+            try:
+                # catch AppleScript errors as the scripting interfce to Photos is flaky
+                selected = photoscript.PhotosLibrary().selection
+                selected_uuid = [p.uuid for p in selected]
+                photos = [p for p in photos if p.uuid in selected_uuid]
+            except Exception:
+                # no photos selected or a selected photo was "open"
+                # selection only works if photos selected in main media browser
+                photos = []
+
         if options.function:
             for function in options.function:
                 photos = function[0](photos)

osxphotos/queryoptions.py

@@ -83,6 +83,7 @@ class QueryOptions:
     location: Optional[bool] = None
     no_location: Optional[bool] = None
     function: Optional[List[Tuple[callable, str]]] = None
+    selected: Optional[bool] = None
 
     def asdict(self):
         return asdict(self)

osxphotos/tutorial.md

@@ -238,6 +238,12 @@ To export only photos contained in the album "Summer Vacation":
 
 `osxphotos export /path/to/export --album "Summer Vacation"`
 
+In Photos, it's possible to have multiple albums with the same name. In this case, osxphotos would export photos from all albums matching the value passed to `--album`.  If you wanted to export only one of the albums and this album is in a folder, the `--regex` option (short for "regular expression"), which does pattern matching, could be used with the `{folder_album}` template to match the specific album.  For example, if you had a "Summer Vacation" album inside the folder "2018" and also one with the same name inside the folder "2019", you could export just the album "2018/Summer Vacation" using this command:
+
+`osxphotos export /path/to/export --regex "2018/Summer Vacation" "{folder_album}"`
+
+This command matches the pattern "2018/Summer Vacation" against the full folder/album path for every photo.
+
 There are also a number of query options to export only certain types of photos.  For example, to export only photos taken with iPhone "Portrait Mode":
 
 `osxphotos export /path/to/export --portrait`

requirements.txt

@@ -15,7 +15,7 @@ dataclasses==0.7;python_version<'3.7'
 wurlitzer==2.1.0
 photoscript==0.1.3
 toml==0.10.2
-osxmetadata==0.99.14
+osxmetadata==0.99.25
 textx==2.3.0
 rich==10.2.2
 bitmath==1.3.3.1

setup.py

@@ -90,7 +90,7 @@ setup(
         "wurlitzer==2.1.0",
         "photoscript==0.1.3",
         "toml==0.10.2",
-        "osxmetadata==0.99.14",
+        "osxmetadata==0.99.25",
         "textx==2.3.0",
         "rich==10.2.2",
         "bitmath==1.3.3.1",