Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
RhetTbull committed Sep 9, 2020
1 parent bc5b0fa commit 500ff7f
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 2 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ photoslib.import_photos(["/Users/rhet/Downloads/test.jpeg"], album=new_album)

photoslib.quit()
```
## Documentation
Full documentation [here](https://github.com/RhetTbull/PhotoScript/blob/master/photoscript.pdf).

Additional documentation about Photos and AppleScript available on the [wiki](https://github.com/RhetTbull/PhotoScript/wiki/Welcome-to-the-PhotoScript-Wiki).

## Limitations
Photos' AppleScript interface is very limited. For example, it cannot access information on faces in photos nor can it delete a photo. PhotoScript is thus limited. PhotoScript works by executing AppleScript through an Objective-C bridge from python. Every method call has to do a python->Objective C->AppleScript round trip; this makes the interface much slower than native python code. This is particularly noticeable when dealing with Folders which requires significant work arounds.
Expand Down
2 changes: 1 addition & 1 deletion photoscript/_version.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
""" version info """

__version__ = "0.0.10"
__version__ = "0.0.11"
2 changes: 1 addition & 1 deletion tests/test_photoscript.py
Original file line number Diff line number Diff line change
Expand Up @@ -362,10 +362,10 @@ def test_photoscript_folder_by_uuid(photoslib):
assert isinstance(folder, photoscript.Folder)
assert folder.name == FOLDER_NAME


# TODO: this test fails
# def test_photoscript_folder_bad_uuid(photoslib):
# """ test getting folder by invalid UUID """

# with pytest.raises(ValueError):
# photoslib.folder(uuid="BAD_UUID")

Expand Down

0 comments on commit 500ff7f

Please sign in to comment.