Updated README, added PhotoInfo.hasadjustments()

2019-07-26 22:21:17 -04:00 · 2019-07-26 22:21:17 -04:00 · 9efa83c5cd
commit 9efa83c5cd
parent ec01bf9706
3 changed files with 225 additions and 20 deletions
--- a/README.md
+++ b/README.md
@ -1,30 +1,24 @@
-[OSXPhotos](https://github.com/RhetTbull/osxphotos)
-========
+# [OSXPhotos](https://github.com/RhetTbull/osxphotos)

-What is osxphotos?
-----------------
+## What is osxphotos?

 OSXPhotos provides the ability to manipulate the Apple's Photos app database on Mac OS X.  

-Supported operating systems
---------------------------
+## Supported operating systems

-Only works on Mac OS X.  Only tested on Mac OS 10.13 and Photos 3.0.  It's quote possible the Photos database schema changed in later versions of Mac OS X and/or the Photos app.
+Only works on Mac OS X.  Only tested on Mac OS 10.13 and Photos 3.0.  

-Installation instructions
-------------------------
+## Installation instructions

 osxmetadata uses setuptools, thus simply run:

 	python setup.py install

-Command Line Usage
------------------
+## Command Line Usage

 This project started as a command line utility, `photosmeta`, available at [photosmeta](https://github.com/RhetTbull/photosmeta) This module converts the photosmeta functionality into a module.  Eventually, I plan to rewrite photosmeta using this module and include it as a command line script in this module.

-Example uses of the module
--------------------------
+## Example uses of the module

 ```python
 import osxphotos
@ -62,21 +56,228 @@ if __name__ == "__main__":
    main()
 ```

-Usage Notes
-----------
+## Module Interface
+
+### PhotosDB
+
+#### Open the default Photos library
+
+```python
+osxphotos.PhotosDB([dbfile="path to database file"])
+```
+
+Opens the Photos library database and returns a PhotosDB object.  Optionally, pass the path to a specific database file.  If `dbfile` is not included, will open the default (last opened) Photos database.
+
+Note: this will open the last library that was opened in Photos. This is not necessarily the System Photos Library.  If you have more than one Photos library, you can select which to open by holding down Option key while opening Photos.
+
+```python
+import osxphotos
+
+photosdb = osxphotos.PhotosDB()
+```
+
+Returns a PhotosDB object. 
+
+#### Open a specific Photos library
+```python
+import osxphotos
+
+photosdb = osxphotos.PhotosDB(dbfile="/Users/smith/Pictures/Test.photoslibrary/database/photos.db")
+```
+
+Pass the fully qualified path to the specific Photos database you want to open. The database is called photos.db and resides in the database folder in your Photos library
+
+#### ```keywords```
+```python
+# assumes photosdb is a PhotosDB object (see above)
+keywords = photosdb.keywords()
+```
+
+Returns a list of the keywords found in the Photos library
+
+#### ```albums```
+```python
+# assumes photosdb is a PhotosDB object (see above)
+albums = photosdb.albums()
+```
+
+Returns a list of the albums found in the Photos library
+
+#### ```persons```
+```python
+# assumes photosdb is a PhotosDB object (see above)
+persons = photosdb.persons()
+```
+
+Returns a list of the persons (faces) found in the Photos library
+
+#### ```keywords_as_dict```
+```python
+# assumes photosdb is a PhotosDB object (see above)
+keyword_dict = photosdb.keywords_as_dict()
+```
+
+Returns a dictionary of keywords found in the Photos library where key is the keyword and value is the count of how many times that keyword appears in the library (ie. how many photos are tagged with the keyword).  Resulting dictionary is in reverse sorted order (e.g. keyword with the highest count is first).
+
+#### ```persons_as_dict```
+```python
+# assumes photosdb is a PhotosDB object (see above)
+persons_dict = photosdb.persons_as_dict()
+```
+
+Returns a dictionary of persons (faces) found in the Photos library where key is the person name and value is the count of how many times that person appears in the library (ie. how many photos are tagged with the person).  Resulting dictionary is in reverse sorted order (e.g. person who appears in the most photos is listed first).
+
+#### ```albums_as_dict```
+```python
+# assumes photosdb is a PhotosDB object (see above)
+albums_dict = photosdb.albums_as_dict()
+```
+
+Returns a dictionary of albums found in the Photos library where key is the album name and value is the count of how many photos are in the album.  Resulting dictionary is in reverse sorted order (e.g. album with the most photos is listed first)
+
+#### ```get_photos_library_path```
+```python
+# assumes photosdb is a PhotosDB object (see above)
+photosdb.get_photos_library_path()
+```
+
+Returns the path to the Photos library as a string
+
+#### ```photos```
+```python
+# assumes photosdb is a PhotosDB object (see above)
+photos = photosdb.photos([keywords=['keyword',]], [uuid=['uuid',]], [persons=['person',]], [albums=['album',]])
+```
+
+Returns a list of PhotoInfo objects.  Each PhotoInfo object represents a photo in the Photos Libary.
+
+If called with no parameters, returns a list of every photo in the Photos library. 
+
+May be called with one or more of the following parameters:
+```python
+photos = photosdb.photos(
+    keywords = [],
+    uuid = [],
+    persons = [],
+    albums = []
+)
+```
+
+- ```keywords```: list of one or more keywords.  Returns only photos containing the keyword(s).  If more than one keyword is provided finds photos matching any of the keywords (e.g. treated as "or")
+- ```uuid```: list of one or more uuids.  Returns only photos whos UUID matches.  Note: The UUID is the universally unique identifier that the Photos database uses to identify each photo.  You shouldn't normally need to use this but it is a way to access a specific photo if you know the UUID.  If more than more uuid is provided, returns photos that match any of the uuids (e.g. treated as "or")
+- ```persons```: list of one or more persons. Returns only photos containing the person(s).  If more than one person provided, returns photos that match any of the persons (e.g. treated as "or")
+- ```albums```: list of one or more album names.  Returns only photos contained in the album(s). If more than one album name is provided, returns photos contained in any of the albums (.e.g. treated as "or")
+
+If more than one of these parameters is provided, they are treated as "and" criteria. E.g.
+
+Finds all photos with (keyword = "wedding" or "birthday") and (persons = "Juan Rodriguez")
+
+```python
+photos=photosdb.photos(keywords=["wedding","birthday"],persons=["Juan Rodriguez"])
+```
+
+Find all photos tagged with keyword "wedding":
+```python
+# assumes photosdb is a PhotosDB object (see above)
+photos = photosdb.photos(keywords=["wedding"])
+ ```
+
+Find all photos of Maria Smith
+```python
+# assumes photosdb is a PhotosDB object (see above)
+photos=photosdb.photos(persons=["Maria Smith"])
+```
+
+Find all photos in album "Summer Vacation" or album "Ski Trip"
+```python
+# assumes photosdb is a PhotosDB object (see above)
+photos=photosdb.photos(albums=["Summer Vacation", "Ski Trip"])
+```
+
+Find the single photo with uuid = "osMNIO5sQFGZTbj9WrydRB"
+```python
+# assumes photosdb is a PhotosDB object (see above)
+photos=photosdb.photos(uuid=["osMNIO5sQFGZTbj9WrydRB"])
+```
+
+If you need to do more complicated searches, you can do this programmaticaly.  For example, find photos with keyword = "Kids" but not in album "Vacation 2019" 
+
+```python
+# assumes photosdb is a PhotosDB object (see above)
+photos1 = photosdb.photos(albums=["Vacation 2019"])
+photos2 = photosdb.photos(keywords=["Kids"])
+photos3 = [p for p in photos2 if p not in photos1]
+```
+
+### PhotoInfo 
+PhotosDB.photos() returns a list of PhotoInfo objects.  Each PhotoInfo object represents a single photo in the Photos library.
+
+#### `uuid()`
+Returns the universally unique identifier (uuid) of the photo.  This is how Photos keeps track of individual photos within the database.
+
+#### `filename()`
+Returns the filename of the photo
+
+#### `date()`
+Returns the date of the photo as a datetime.datetime object
+
+#### `description()`
+Returns the description of the photo
+
+#### `name()`
+Returns the name (or the title as Photos calls it) of the photo
+
+#### `keywords()`
+Returns a list of keywords (e.g. tags) applied to the photo
+
+#### `albums()`
+Returns a list of albums the photo is contained in
+
+#### `persons()`
+Returns the names of the persons in the photo
+
+#### `path()`
+Returns the path to the photo on disk as a string.  Note: this returns the path to the *original* unedited file (see `hasadjustments()`).  If the file is missing on disk, path=`None` (see `ismissing()`)
+
+#### `ismissing()`
+Returns `True` if the original image file is missing on disk, otherwise `False`.  This can occur if the file has been uploaded to iCloud but not yet downloaded to the local library or if the file was deleted or imported from a disk that has been unmounted. Note: this status is set by Photos and osxphotos does not verify that the file path returned by `path()` actually exists.  It merely reports what Photos has stored in the library database. 
+
+#### `hasadjustments()`
+Returns `True` if the file has been edited in Photos, otherwise `False`
+
+Examples:
+
+```python
+# assumes photosdb is a PhotosDB object (see above)
+photos=photosdb.photos()
+for p in photos:
+    print(
+        p.uuid(),
+        p.filename(),
+        p.date(),
+        p.description(),
+        p.name(),
+        p.keywords(),
+        p.albums(),
+        p.persons(),
+        p.path(),
+        p.ismissing(),
+        p.hasadjustments(),
+    )
+```
+
+## Implementation Notes

 This module is very kludgy.  It works by creating a copy of the sqlite3 database that Photos uses to store data about the Photos library. The class PhotosDB then queries this database to extract information about the photos such as persons (faces identified in the photos), albums, keywords, etc.  

-If Apple changes the database format this will break.  
+If Apple changes the database format this will likely break.  

 The sqlite3 database used by Photos uses write ahead logging that is updated asynchronously in the background by a Photos helper service.  Sometimes the update takes a long time meaning the latest changes made in Photos (e.g. add a keyword) will not show up in the database for sometime.  I know of no way around this.

-Dependencies
------------
+## Dependencies
 [PyObjC](https://pythonhosted.org/pyobjc/)

-Acknowledgements
----------------
+## Acknowledgements
 This code was inspired by photo-export by Patrick Fältström see: (https://github.com/patrikhson/photo-export) Copyright (c) 2015 Patrik Fältström paf@frobbit.se

 To interact with the Photos app, I use [py-applescript]( https://github.com/rdhyee/py-applescript) by "Raymond Yee / rdhyee".  Rather than import this module, I included the entire module
--- a/examples/examples.py
+++ b/examples/examples.py
@ -36,6 +36,7 @@ def main():
            p.persons(),
            p.path(),
            p.ismissing(),
+            p.hasadjustments(),
        )


--- a/osxphotos/init.py
+++ b/osxphotos/init.py
@ -621,6 +621,9 @@ class PhotoInfo:
    def ismissing(self):
        return True if self.__info["isMissing"] == 1 else False

+    def hasadjustments(self):
+        return True if self.__info["hasAdjustments"] == 1 else False
+
    # compare two PhotoInfo objects for equality
    def __eq__(self, other):
        if isinstance(other, self.__class__):