Package: osxphotos
What is osxphotos?OSXPhotos provides both the ability to interact with and query Apple’s Photos.app library on macOS directly from your python code
as well as a very flexible command line interface (CLI) app for exporting photos.
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.Supported operating systemsOnly works on macOS (aka Mac OS X). Tested on macOS Sierra (10.12.6) through macOS Monterey (12.3).This package will read Photos databases for any supported version on any supported macOS version.
E.g. you can read a database created with Photos 5.0 on MacOS 10.15 on a machine running macOS 10.12 and vice versa.Requires python >=3.9.InstallationIf you just want to use the command line application, I recommend you to install using pipx. See other advanced options below.Installation using pipxIf you aren’t familiar with installing python applications, I recommend you installosxphotoswithpipx. If you usepipx, you will not need to create a virtual environment aspipxtakes care of this. The easiest way to do this on a Mac is to usehomebrew:OpenTerminal(search forTerminalin Spotlight or look inApplications/Utilities)Installhomebrewaccording to instructions athttps://brew.sh/Type the following into Terminal:brew install pipxThen type this:pipx install osxphotosNow you should be able to runosxphotosby typing:osxphotosInstallation using pipYou can also install directly frompypi:python3 -m pip install osxphotosCommand Line UsageThis package will install a command line utility calledosxphotosthat allows you to query the Photos database and export photos.
Alternatively, you can also run the command line utility like this:python3-mosxphotos> osxphotos
Usage: osxphotos [OPTIONS] COMMAND [ARGS]...

Options:
  --db <Photos database path>  Specify Photos database path. Path to Photos
                              library/database can be specified using either
                              --db or directly as PHOTOS_LIBRARY positional
                              argument. If neither --db or PHOTOS_LIBRARY
                              provided, will attempt to find the library to
                              use in the following order: 1. last opened
                              library, 2. system library, 3.
                              ~/Pictures/Photos Library.photoslibrary
  --json                      Print output in JSON format.
  -v, --version                Show the version and exit.
  -h, --help                   Show this message and exit.


Commands:
  about      Print information about osxphotos including license.
  albums     Print out albums found in the Photos library.
  diff       Compare two Photos databases and print out differences
  docs       Open osxphotos documentation in your browser.
  dump       Print list of all photos & associated info from the Photos...
  exiftool   Run exiftool on previously exported files to update metadata.
  export     Export photos from the Photos database.
  exportdb   Utilities for working with the osxphotos export database
  help       Print help; for help on commands: help <command>.
  info       Print out descriptive info of the Photos library database.
  inspect    Interactively inspect photos selected in Photos.
  install    Install Python packages into the same environment as osxphotos
  keywords   Print out keywords found in the Photos library.
  labels     Print out image classification labels found in the Photos...
  list       Print list of Photos libraries found on the system.
  persons    Print out persons (faces) found in the Photos library.
  places     Print out places found in the Photos library.
  query      Query the Photos database using 1 or more search options; if...
  repl       Run interactive osxphotos REPL shell (useful for debugging,...
  run        Run a python file using same environment as osxphotos
  snap       Create snapshot of Photos database to use with diff command
  theme      Manage osxphotos color themes.
  timewarp   Adjust date/time/timezone of photos in Apple Photos.
  tutorial   Display osxphotos tutorial.
  uninstall  Uninstall Python packages from the osxphotos environment
  uuid       Print out unique IDs (UUID) of photos selected in Photos
  version    Check for new version of osxphotos.To get help on a specific command, useosxphotos help <command_name>Command line examplesexport all photos to ~/Desktop/export group in folders by date createdosxphotos export--export-by-date~/Pictures/Photos\ Library.photoslibrary ~/Desktop/exportNote: Photos library/database path can also be specified using--dboption:osxphotos export--export-by-date--db~/Pictures/Photos\ Library.photoslibrary ~/Desktop/exportfind all photos with keyword “Kids” and output results to json file named results.json:osxphotos query--keywordKids--json~/Pictures/Photos\ Library.photoslibrary >results.jsonexport photos to file structure based on 4-digit year and full name of month of photo’s creation date:osxphotos export ~/Desktop/export--directory"{created.year}/{created.month}"(by default, it will attempt to use the system library)export photos to file structure based on 4-digit year of photo’s creation date and add keywords for media type and labels (labels are only awailable on Photos 5 and higher):osxphotos export ~/Desktop/export--directory"{created.year}"--keyword-template"{label}"--keyword-template"{media_type}"export default library using ‘country name/year’ as output directory (but use “NoCountry/year” if country not specified), add persons, album names, and year as keywords, write exif metadata to files when exporting, update only changed files, print verbose ouputosxphotos export ~/Desktop/export--directory"{place.name.country,NoCountry}/{created.year}"--person-keyword--album-keyword--keyword-template"{created.year}"--exiftool--update--verbosefind all videos larger than 200MB and add them to Photos album “Big Videos” creating the album if necessaryosxphotos query--only-movies--min-size200MB--add-to-album"Big Videos"Example uses of the package""" Simple usage of the package """importosxphotosdefmain():photosdb=osxphotos.PhotosDB()print(photosdb.keywords)print(photosdb.persons)print(photosdb.album_names)print(photosdb.keywords_as_dict)print(photosdb.persons_as_dict)print(photosdb.albums_as_dict)# find all photos with Keyword = Foo and containing John Smithphotos=photosdb.photos(keywords=["Foo"],persons=["John Smith"])# find all photos that include Alice Smith but do not contain the keyword Barphotos=[pforpinphotosdb.photos(persons=["Alice Smith"])ifpnotinphotosdb.photos(keywords=["Bar"])]forpinphotos:print(p.uuid,p.filename,p.original_filename,p.date,p.description,p.title,p.keywords,p.albums,p.persons,p.path,)if__name__=="__main__":main()""" Export all photos to specified directory using album names as folders
    If file has been edited, also export the edited version,
    otherwise, export the original version
    This will result in duplicate photos if photo is in more than album """importos.pathimportpathlibimportsysimportclickfrompathvalidateimportis_valid_filepath,sanitize_filepathimportosxphotos@click.command()@click.argument("export_path",type=click.Path(exists=True))@click.option("--default-album",help="Default folder for photos with no album. Defaults to 'unfiled'",default="unfiled",)@click.option("--library-path",help="Path to Photos library, default to last used library",default=None,)defexport(export_path,default_album,library_path):export_path=os.path.expanduser(export_path)library_path=os.path.expanduser(library_path)iflibrary_pathelseNoneiflibrary_pathisnotNone:photosdb=osxphotos.PhotosDB(library_path)else:photosdb=osxphotos.PhotosDB()photos=photosdb.photos()forpinphotos:ifnotp.ismissing:albums=p.albumsifnotalbums:albums=[default_album]foralbuminalbums:click.echo(f"exporting{p.filename}in album{album}")# make sure no invalid characters in destination path (could be in album name)album_name=sanitize_filepath(album,platform="auto")# create destination folder, if necessary, based on album namedest_dir=os.path.join(export_path,album_name)# verify path is a valid pathifnotis_valid_filepath(dest_dir,platform="auto"):sys.exit(f"Invalid filepath{dest_dir}")# create destination dir if neededifnotos.path.isdir(dest_dir):os.makedirs(dest_dir)# export the photoifp.hasadjustments:# export edited versionexported=p.export(dest_dir,edited=True)edited_name=pathlib.Path(p.path_edited).nameclick.echo(f"Exported{edited_name}to{exported}")# export unedited versionexported=p.export(dest_dir)click.echo(f"Exported{p.filename}to{exported}")else:click.echo(f"Skipping missing photo:{p.filename}")if__name__=="__main__":export()# pylint: disable=no-value-for-parameterPackage InterfaceReference full documentation onGitHub