forked/osxphotos
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated Structure of the code (markdown)

Rhet Turnbull
2021-01-03 15:45:51 -08:00
parent 63d6c762d7
commit a8d5ff063f
1 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
Structure-of-the-code.md

@@ -16,12 +16,19 @@ The package code is organized in osxphotos per the table below. Most of the file
|---|---| |---|---|
|`__init__.py`| this is what gets read by "import osxphotos"| |`__init__.py`| this is what gets read by "import osxphotos"|
|`__main__.py`| the command line interface, what gets executed with python3 -m osxphotos| |`__main__.py`| the command line interface, what gets executed with python3 -m osxphotos|
|`_applescript/`| contains a copy of [py-applescript](https://github.com/rdhyee/py-applescript) used to interact directly with Photos via applescript to force the download of photos from iCloud if needed|
|`_constants.py`| constants used by the other modules| |`_constants.py`| constants used by the other modules|
|`_version.py`| version string| |`_version.py`| version string|
|`albuminfo.py`| AlbumInfo and FolderInfo classes| |`albuminfo.py`| AlbumInfo and FolderInfo classes|
|`datetime_formatter.py`| utility methods for formatting datetime objects| |`configoptions.py`| ConfigOptions class to load/save config settings for osxphotos CLI|
|`datetime_formatter.py`| Utility functions for formatting datetime objects, used by phototemplate.py|
|`datetime_utils.py`| Utility functions for working with datetime objects|
|`exiftool.py`| ExifTool class| |`exiftool.py`| ExifTool class|
|`export_db.py`| ExportDB class used by CLI to cache data about exports|
|`fileutil.py`| FileUtil class used by CLI and export for enabling --dry-run option|
|`imageconverter.py`| ImageConverter class that converts an image to JPEG using CoreImage|
|`pathutils.py`| Utility functions for validating/sanitizing path components|
|`photokit.py`| Interface to Apple's PhotoKit framework for direct access to photos stored
in the user's Photos library.|
|`photoinfo/`| PhotoInfo class| |`photoinfo/`| PhotoInfo class|
|`photosdb/`| PhotosDB class| |`photosdb/`| PhotosDB class|
|`phototemplate.py`| PhotoTemplate class| |`phototemplate.py`| PhotoTemplate class|