Welcome to OSXPhotos's documentation!¶
- OSXPhotos
- OSXPhotos Tutorial
- Overview
- Export your photos
- Export by date
- Specify directory structure
- Specify exported filename
- Edited photos
- Specifying the Photos library
- Missing photos
- Exporting to external disks
- Exporting metadata with exported photos
- Removing a keyword during export
- Sidecar files
- Updating a previous export
- Dry Run
- Creating a report of all exported files
- Exporting only certain photos
- Converting images to JPEG on export
- Finder attributes
- Saving and loading options
- Run commands on exported photos for post-processing
- An example from an actual osxphotos user
- Color Themes
- Conclusion
- OSXPhotos Command Line Interface (CLI)
- OSXPhotos Template System
- OSXPhotos Python Package Overview
- OSXPhotos Python API
- Table of Contents
- Example uses of the Python package
- Concurrency
- Calling CLI commands from Python
- Package Interface
- PhotosDB
- Read a Photos library database
- Open the default (last opened) Photos library
- Open System Photos library
- Open a specific Photos library
- photos(keywords=None, uuid=None, persons=None, albums=None, images=True, movies=True, from_date=None, to_date=None, intrash=False)
- get_photo(uuid)
- query(options: QueryOptions) -> List[PhotoInfo]:
- keywords
- album_info
- albums
- albums_shared
- import_info
- project_info
- moment_info
- folder_info
- folders
- persons
- person_info
- keywords_as_dict
- keywords_without_photo
- persons_as_dict
- albums_as_dict
- albums_shared_as_dict
- labels
- labels_normalized
- labels_as_dict
- labels_normalized_as_dict
- library_path
- db_path
- db_version
- photos_version
- get_db_connection()
- execute(sql)
- QueryOptions
- PhotoInfo
- uuid
- filename
- original_filename
- date
- tzoffset
- tzname
- date_original
- date_added
- date_modified
- description
- title
- keywords
- albums
- album_info
- import_info
- project_info
- persons
- person_info
- face_info
- path
- path_edited
- path_derivatives
- path_raw
- has_raw
- israw
- raw_original
- height
- width
- orientation
- original_height
- original_width
- original_orientation
- original_filesize
- ismissing
- hasadjustments
- adjustments
- external_edit
- favorite
- flagged
- rating
- hidden
- visible
- intrash
- date_trashed
- location
- latitude
- longitude
- place
- shared
- owner
- comments
- likes
- isreference
- isphoto
- ismovie
- iscloudasset
- incloud
- syndicated
- saved_to_library
- shared_moment
- shared_library
- share_participant_info
- share_participants
- uti
- uti_original
- uti_edited
- uti_raw
- burst
- burst_selected
- burst_key
- burst_default_pick
- burst_photos
- burst_albums
- burst_album_info
- live_photo
- path_live_photo
- path_edited_live_photo
- portrait
- hdr
- selfie
- time_lapse
- panorama
- slow_mo
- labels
- labels_normalized
- search_info
- search_info_normalized
- exif_info
- exiftool
- score
- duplicates
- cloud_guid
- cloud_owner_hashed_id
- fingerprint
- hexdigest
- tables()
- json()
- asdict()
- export()
- render_template(template_str, options=None)
- detected_text(confidence_threshold=TEXT_DETECTION_CONFIDENCE_THRESHOLD)
- ExifInfo
- AlbumInfo
- ImportInfo
- ProjectInfo
- MomentInfo
- FolderInfo
- PlaceInfo
- ScoreInfo
- SearchInfo
- PersonInfo
- FaceInfo
- CommentInfo
- LikeInfo
- AdjustmentsInfo
- PhotoTables
- Raw Photos
- Template System
- ExifTool
- PhotoExporter
- ExifWriter
- SidecarWriter
- PhotosAlbum
- Text Detection
- Compare Libraries
- Utility Functions
- PhotosDB
- Additional Examples
- OSXPhotos Python Reference
AlbumInfo
AlbumSortOrder
CommentInfo
ExifInfo
ExifTool
ExifWriter
ExportDB
ExportDB.close()
ExportDB.connection
ExportDB.create_file_record()
ExportDB.create_or_get_file_record()
ExportDB.delete_data_for_filepath()
ExportDB.delete_data_for_uuid()
ExportDB.export_dir
ExportDB.get_export_results()
ExportDB.get_exported_files()
ExportDB.get_file_record()
ExportDB.get_files_for_uuid()
ExportDB.get_history()
ExportDB.get_last_export_directory()
ExportDB.get_photoinfo_for_uuid()
ExportDB.get_previous_uuids()
ExportDB.get_target_for_file()
ExportDB.get_uuid_for_file()
ExportDB.path
ExportDB.set_config()
ExportDB.set_export_results()
ExportDB.set_history()
ExportDB.set_photoinfo_for_uuid()
ExportDBTemp
ExportOptions
ExportOptions.convert_to_jpeg
ExportOptions.description_template
ExportOptions.download_missing
ExportOptions.dry_run
ExportOptions.edited
ExportOptions.exiftool_flags
ExportOptions.exiftool
ExportOptions.export_as_hardlink
ExportOptions.export_db
ExportOptions.face_regions
ExportOptions.fileutil
ExportOptions.force_update
ExportOptions.ignore_date_modified
ExportOptions.ignore_signature
ExportOptions.increment
ExportOptions.jpeg_ext
ExportOptions.jpeg_quality
ExportOptions.keyword_template
ExportOptions.live_photo
ExportOptions.location
ExportOptions.merge_exif_keywords
ExportOptions.merge_exif_persons
ExportOptions.overwrite
ExportOptions.persons
ExportOptions.preview_suffix
ExportOptions.preview
ExportOptions.raw_photo
ExportOptions.render_options
ExportOptions.replace_keywords
ExportOptions.rich
ExportOptions.export_aae
ExportOptions.sidecar_drop_ext
ExportOptions.sidecar
ExportOptions.strip
ExportOptions.timeout
ExportOptions.touch_file
ExportOptions.update
ExportOptions.update_errors
ExportOptions.use_albums_as_keywords
ExportOptions.use_persons_as_keywords
ExportOptions.use_photos_export
ExportOptions.use_photokit
ExportOptions.verbose
ExportOptions.tmpdir
ExportOptions.favorite_rating
ExportOptions.fix_orientation
ExportOptions.bit_flags
ExportResults
FaceInfo
FileUtil
FileUtilNoOp
FolderInfo
ImportInfo
LikeInfo
MomentInfo
PersonInfo
PhotoExporter
PhotoInfo
PhotoInfo.adjustments
PhotoInfo.adjustments_path
PhotoInfo.album_info
PhotoInfo.albums
PhotoInfo.asdict()
PhotoInfo.burst
PhotoInfo.burst_album_info
PhotoInfo.burst_albums
PhotoInfo.burst_default_pick
PhotoInfo.burst_key
PhotoInfo.burst_photos
PhotoInfo.burst_selected
PhotoInfo.cloud_guid
PhotoInfo.cloud_metadata
PhotoInfo.cloud_owner_hashed_id
PhotoInfo.comments
PhotoInfo.date
PhotoInfo.date_added
PhotoInfo.date_modified
PhotoInfo.date_original
PhotoInfo.date_trashed
PhotoInfo.description
PhotoInfo.detected_text()
PhotoInfo.duplicates
PhotoInfo.exif_info
PhotoInfo.exiftool
PhotoInfo.export()
PhotoInfo.external_edit
PhotoInfo.face_info
PhotoInfo.favorite
PhotoInfo.filename
PhotoInfo.fingerprint
PhotoInfo.flagged
PhotoInfo.has_raw
PhotoInfo.hasadjustments
PhotoInfo.hdr
PhotoInfo.height
PhotoInfo.hexdigest
PhotoInfo.hidden
PhotoInfo.import_info
PhotoInfo.incloud
PhotoInfo.intrash
PhotoInfo.iscloudasset
PhotoInfo.ismissing
PhotoInfo.ismovie
PhotoInfo.isphoto
PhotoInfo.israw
PhotoInfo.isreference
PhotoInfo.json()
PhotoInfo.keywords
PhotoInfo.labels
PhotoInfo.labels_normalized
PhotoInfo.latitude
PhotoInfo.likes
PhotoInfo.live_photo
PhotoInfo.location
PhotoInfo.longitude
PhotoInfo.moment_info
PhotoInfo.orientation
PhotoInfo.original_filename
PhotoInfo.original_filesize
PhotoInfo.original_height
PhotoInfo.original_orientation
PhotoInfo.original_width
PhotoInfo.owner
PhotoInfo.panorama
PhotoInfo.path
PhotoInfo.path_derivatives
PhotoInfo.path_edited
PhotoInfo.path_edited_live_photo
PhotoInfo.path_live_photo
PhotoInfo.path_raw
PhotoInfo.person_info
PhotoInfo.persons
PhotoInfo.place
PhotoInfo.portrait
PhotoInfo.project_info
PhotoInfo.rating
PhotoInfo.raw_original
PhotoInfo.render_template()
PhotoInfo.saved_to_library
PhotoInfo.score
PhotoInfo.screen_recording
PhotoInfo.screenshot
PhotoInfo.search_info
PhotoInfo.search_info_normalized
PhotoInfo.selfie
PhotoInfo.share_info
PhotoInfo.share_participant_info
PhotoInfo.share_participants
PhotoInfo.shared
PhotoInfo.shared_library
PhotoInfo.shared_moment
PhotoInfo.shared_moment_info
PhotoInfo.slow_mo
PhotoInfo.syndicated
PhotoInfo.tables()
PhotoInfo.time_lapse
PhotoInfo.title
PhotoInfo.tzname
PhotoInfo.tzoffset
PhotoInfo.uti
PhotoInfo.uti_edited
PhotoInfo.uti_original
PhotoInfo.uti_raw
PhotoInfo.uuid
PhotoInfo.visible
PhotoInfo.width
PhotoTemplate
PhotoTemplate.expand_variables()
PhotoTemplate.expand_variables_to_str()
PhotoTemplate.filter_predicate()
PhotoTemplate.get_field_values()
PhotoTemplate.get_filter_values()
PhotoTemplate.get_format_values()
PhotoTemplate.get_media_type()
PhotoTemplate.get_photo_bool_attribute()
PhotoTemplate.get_photo_video_type()
PhotoTemplate.get_template_value()
PhotoTemplate.get_template_value_exiftool()
PhotoTemplate.get_template_value_filter_function()
PhotoTemplate.get_template_value_function()
PhotoTemplate.get_template_value_multi()
PhotoTemplate.get_template_value_pathlib()
PhotoTemplate.render()
PhotosAlbum
PhotosAlbumPhotoScript
PhotosDB
PhotosDB.album_info
PhotosDB.album_info_shared
PhotosDB.albums
PhotosDB.albums_as_dict
PhotosDB.albums_shared
PhotosDB.albums_shared_as_dict
PhotosDB.db_path
PhotosDB.db_version
PhotosDB.execute()
PhotosDB.folder_info
PhotosDB.folders
PhotosDB.get_db_connection()
PhotosDB.get_photo()
PhotosDB.import_info
PhotosDB.keywords
PhotosDB.keywords_as_dict
PhotosDB.keywords_without_photo
PhotosDB.labels
PhotosDB.labels_as_dict
PhotosDB.labels_normalized
PhotosDB.labels_normalized_as_dict
PhotosDB.library_path
PhotosDB.person_info
PhotosDB.persons
PhotosDB.persons_as_dict
PhotosDB.photos()
PhotosDB.photos_by_uuid()
PhotosDB.photos_version
PhotosDB.project_info
PhotosDB.query()
PlaceInfo
ProjectInfo
QueryOptions
QueryOptions.added_after
QueryOptions.added_before
QueryOptions.added_in_last
QueryOptions.album
QueryOptions.burst_photos
QueryOptions.burst
QueryOptions.cloudasset
QueryOptions.deleted_only
QueryOptions.deleted
QueryOptions.description
QueryOptions.duplicate
QueryOptions.edited
QueryOptions.exif
QueryOptions.external_edit
QueryOptions.favorite
QueryOptions.folder
QueryOptions.from_date
QueryOptions.from_time
QueryOptions.function
QueryOptions.has_comment
QueryOptions.has_likes
QueryOptions.has_raw
QueryOptions.hdr
QueryOptions.hidden
QueryOptions.ignore_case
QueryOptions.in_album
QueryOptions.incloud
QueryOptions.is_reference
QueryOptions.keyword
QueryOptions.label
QueryOptions.live
QueryOptions.location
QueryOptions.max_size
QueryOptions.min_size
QueryOptions.missing_bursts
QueryOptions.missing
QueryOptions.movies
QueryOptions.name
QueryOptions.no_comment
QueryOptions.no_description
QueryOptions.no_likes
QueryOptions.no_location
QueryOptions.no_keyword
QueryOptions.no_place
QueryOptions.no_title
QueryOptions.not_burst
QueryOptions.not_cloudasset
QueryOptions.not_edited
QueryOptions.not_favorite
QueryOptions.not_hdr
QueryOptions.not_hidden
QueryOptions.not_in_album
QueryOptions.not_incloud
QueryOptions.not_live
QueryOptions.not_missing
QueryOptions.not_panorama
QueryOptions.not_portrait
QueryOptions.not_reference
QueryOptions.not_screenshot
QueryOptions.not_screen_recording
QueryOptions.not_selfie
QueryOptions.not_shared
QueryOptions.not_slow_mo
QueryOptions.not_time_lapse
QueryOptions.panorama
QueryOptions.person
QueryOptions.photos
QueryOptions.place
QueryOptions.portrait
QueryOptions.query_eval
QueryOptions.regex
QueryOptions.screenshot
QueryOptions.screen_recording
QueryOptions.selected
QueryOptions.selfie
QueryOptions.shared
QueryOptions.slow_mo
QueryOptions.time_lapse
QueryOptions.title
QueryOptions.to_date
QueryOptions.to_time
QueryOptions.uti
QueryOptions.uuid
QueryOptions.year
QueryOptions.syndicated
QueryOptions.not_syndicated
QueryOptions.saved_to_library
QueryOptions.not_saved_to_library
QueryOptions.shared_moment
QueryOptions.not_shared_moment
QueryOptions.shared_library
QueryOptions.not_shared_library
ScoreInfo
SearchInfo
SearchInfo.activities
SearchInfo.all
SearchInfo.asdict()
SearchInfo.bodies_of_water
SearchInfo.camera
SearchInfo.city
SearchInfo.country
SearchInfo.detected_text
SearchInfo.holidays
SearchInfo.labels
SearchInfo.locality_names
SearchInfo.media_types
SearchInfo.month
SearchInfo.neighborhoods
SearchInfo.place_names
SearchInfo.season
SearchInfo.source
SearchInfo.state
SearchInfo.state_abbreviation
SearchInfo.streets
SearchInfo.text_found
SearchInfo.venue_types
SearchInfo.venues
SearchInfo.year
SidecarWriter
iPhotoAlbumInfo
iPhotoDB
iPhotoFaceInfo
iPhotoFaceInfo.asdict()
iPhotoFaceInfo.center
iPhotoFaceInfo.center_x
iPhotoFaceInfo.center_y
iPhotoFaceInfo.face_rect()
iPhotoFaceInfo.json()
iPhotoFaceInfo.mpri_reg_rect
iPhotoFaceInfo.mwg_rs_area
iPhotoFaceInfo.name
iPhotoFaceInfo.person_info
iPhotoFaceInfo.pitch
iPhotoFaceInfo.quality
iPhotoFaceInfo.roll
iPhotoFaceInfo.roll_pitch_yaw()
iPhotoFaceInfo.size
iPhotoFaceInfo.size_pixels
iPhotoFaceInfo.yaw
iPhotoFolderInfo
iPhotoPersonInfo
iPhotoPhotoInfo
iPhotoPhotoInfo.album_info
iPhotoPhotoInfo.albums
iPhotoPhotoInfo.asdict()
iPhotoPhotoInfo.burst
iPhotoPhotoInfo.burst_album_info
iPhotoPhotoInfo.burst_albums
iPhotoPhotoInfo.burst_photos
iPhotoPhotoInfo.date
iPhotoPhotoInfo.date_added
iPhotoPhotoInfo.date_modified
iPhotoPhotoInfo.date_original
iPhotoPhotoInfo.description
iPhotoPhotoInfo.event_info
iPhotoPhotoInfo.exif_info
iPhotoPhotoInfo.exiftool
iPhotoPhotoInfo.export()
iPhotoPhotoInfo.face_info
iPhotoPhotoInfo.favorite
iPhotoPhotoInfo.filename
iPhotoPhotoInfo.fingerprint
iPhotoPhotoInfo.flagged
iPhotoPhotoInfo.hasadjustments
iPhotoPhotoInfo.height
iPhotoPhotoInfo.hexdigest
iPhotoPhotoInfo.hidden
iPhotoPhotoInfo.intrash
iPhotoPhotoInfo.ismissing
iPhotoPhotoInfo.ismovie
iPhotoPhotoInfo.isphoto
iPhotoPhotoInfo.israw
iPhotoPhotoInfo.isreference
iPhotoPhotoInfo.json()
iPhotoPhotoInfo.keywords
iPhotoPhotoInfo.latitude
iPhotoPhotoInfo.location
iPhotoPhotoInfo.longitude
iPhotoPhotoInfo.moment_info
iPhotoPhotoInfo.orientation
iPhotoPhotoInfo.original_filename
iPhotoPhotoInfo.original_filesize
iPhotoPhotoInfo.original_height
iPhotoPhotoInfo.original_width
iPhotoPhotoInfo.path
iPhotoPhotoInfo.path_derivatives
iPhotoPhotoInfo.path_edited
iPhotoPhotoInfo.person_info
iPhotoPhotoInfo.persons
iPhotoPhotoInfo.rating
iPhotoPhotoInfo.raw_original
iPhotoPhotoInfo.render_template()
iPhotoPhotoInfo.title
iPhotoPhotoInfo.tzname
iPhotoPhotoInfo.tzoffset
iPhotoPhotoInfo.uti
iPhotoPhotoInfo.uti_edited
iPhotoPhotoInfo.uti_original
iPhotoPhotoInfo.uti_raw
iPhotoPhotoInfo.uuid
iPhotoPhotoInfo.visible
iPhotoPhotoInfo.width
is_debug()
set_debug()