Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
RhetTbull committed Nov 22, 2023
1 parent 878ccb9 commit 5ebf6dd
Show file tree
Hide file tree
Showing 10 changed files with 40 additions and 22 deletions.
5 changes: 2 additions & 3 deletions API_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1459,7 +1459,7 @@ Returns a dictionary representation of all photo info.

#### `export()`

`export(dest, filename=None, edited=False, live_photo=False, export_as_hardlink=False, overwrite=False, increment=True, sidecar_json=False, sidecar_exiftool=False, sidecar_xmp=False, download_missing=False, use_photos_export=False, use_photokit=True, timeout=120, exiftool=False, use_albums_as_keywords=False, use_persons_as_keywords=False)`
`export(dest, filename=None, edited=False, live_photo=False, export_as_hardlink=False, overwrite=False, increment=True, sidecar_json=False, sidecar_exiftool=False, sidecar_xmp=False, use_photos_export=False, use_photokit=True, timeout=120, exiftool=False, use_albums_as_keywords=False, use_persons_as_keywords=False)`

Export photo from the Photos library to another destination on disk.

Expand All @@ -1475,8 +1475,7 @@ Export photo from the Photos library to another destination on disk.
* sidecar_exiftool: (bool, default = False); if True will also write a json sidecar with metadata in format readable by exiftool; sidecar filename will be dest/filename.json where filename is the stem of the photo name; resulting json file will not include tag group names (e.g. `exiftool -j`)
* sidecar_xmp: (bool, default = False); if True will also write a XMP sidecar with metadata; sidecar filename will be dest/filename.xmp where filename is the stem of the photo name
* use_photos_export: (bool, default=False); if True will attempt to export photo via AppleScript or PhotoKit interaction with Photos
* download_missing: (bool, default=False); if True will attempt to export photo via AppleScript or PhotoKit interaction with Photos if missing
* use_photokit: (bool, default=True); if True will attempt to export photo via photokit instead of AppleScript when used with use_photos_export or download_missing
* use_photokit: (bool, default=True); if True will attempt to export photo via photokit instead of AppleScript when used with use_photos_export
* timeout: (int, default=120) timeout in seconds used with use_photos_export
* exiftool: (bool, default = False) if True, will use [exiftool](https://exiftool.org/) to write metadata directly to the exported photo; exiftool must be installed and in the system path
* use_albums_as_keywords: (bool, default = False); if True, will use album names as keywords when exporting metadata with exiftool or sidecar
Expand Down
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1506,6 +1506,28 @@ Options:
is cancelled or crashes. Default is 1000; to
prevent checkpointing of database, use
`--checkpoint 0` [x>=0]
-F, --ignore-exportdb If exporting to a directory that already
contains an export database and --update is
not specified, do not prompt to continue but
instead continue the export. Normally, if you
export to a directory that already contains an
export database and do not specify --update,
osxphotos will prompt you to continue. This is
because you may be inadvertently merging two
export sets. Use --ignore-exportdb to skip
this prompt and continue the export. The
resulting export database will contain the
combined state of both export sets. Short
option is '-F' (mnemonic: force export). See
also --update.
--no-exportdb Do not create an export database. This exports
all photos in the export set but does not save
any state information in the osxphotos export
database. If you use --no-exportdb, you will
not be able to use --update on subsequent
exports. It is recommended that you do not use
this option unless you are certain you
understand the implications.
--tmpdir DIR Specify alternate temporary directory. Default
is system temporary directory. osxphotos needs
to create a number of temporary files during
Expand Down
5 changes: 2 additions & 3 deletions docs/API_README.html
Original file line number Diff line number Diff line change
Expand Up @@ -1556,7 +1556,7 @@ <h4><code class="docutils literal notranslate"><span class="pre">asdict()</span>
</section>
<section id="export">
<h4><code class="docutils literal notranslate"><span class="pre">export()</span></code><a class="headerlink" href="#export" title="Link to this heading">#</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">export(dest,</span> <span class="pre">filename=None,</span> <span class="pre">edited=False,</span> <span class="pre">live_photo=False,</span> <span class="pre">export_as_hardlink=False,</span> <span class="pre">overwrite=False,</span> <span class="pre">increment=True,</span> <span class="pre">sidecar_json=False,</span> <span class="pre">sidecar_exiftool=False,</span> <span class="pre">sidecar_xmp=False,</span> <span class="pre">download_missing=False,</span> <span class="pre">use_photos_export=False,</span> <span class="pre">use_photokit=True,</span> <span class="pre">timeout=120,</span> <span class="pre">exiftool=False,</span> <span class="pre">use_albums_as_keywords=False,</span> <span class="pre">use_persons_as_keywords=False)</span></code></p>
<p><code class="docutils literal notranslate"><span class="pre">export(dest,</span> <span class="pre">filename=None,</span> <span class="pre">edited=False,</span> <span class="pre">live_photo=False,</span> <span class="pre">export_as_hardlink=False,</span> <span class="pre">overwrite=False,</span> <span class="pre">increment=True,</span> <span class="pre">sidecar_json=False,</span> <span class="pre">sidecar_exiftool=False,</span> <span class="pre">sidecar_xmp=False,</span> <span class="pre">use_photos_export=False,</span> <span class="pre">use_photokit=True,</span> <span class="pre">timeout=120,</span> <span class="pre">exiftool=False,</span> <span class="pre">use_albums_as_keywords=False,</span> <span class="pre">use_persons_as_keywords=False)</span></code></p>
<p>Export photo from the Photos library to another destination on disk.</p>
<ul class="simple">
<li><p>dest: must be valid destination path as str (or exception raised).</p></li>
Expand All @@ -1571,8 +1571,7 @@ <h4><code class="docutils literal notranslate"><span class="pre">export()</span>
<li><p>sidecar_exiftool: (bool, default = False); if True will also write a json sidecar with metadata in format readable by exiftool; sidecar filename will be dest/filename.json where filename is the stem of the photo name; resulting json file will not include tag group names (e.g. <code class="docutils literal notranslate"><span class="pre">exiftool</span> <span class="pre">-j</span></code>)</p></li>
<li><p>sidecar_xmp: (bool, default = False); if True will also write a XMP sidecar with metadata; sidecar filename will be dest/filename.xmp where filename is the stem of the photo name</p></li>
<li><p>use_photos_export: (bool, default=False); if True will attempt to export photo via AppleScript or PhotoKit interaction with Photos</p></li>
<li><p>download_missing: (bool, default=False); if True will attempt to export photo via AppleScript or PhotoKit interaction with Photos if missing</p></li>
<li><p>use_photokit: (bool, default=True); if True will attempt to export photo via photokit instead of AppleScript when used with use_photos_export or download_missing</p></li>
<li><p>use_photokit: (bool, default=True); if True will attempt to export photo via photokit instead of AppleScript when used with use_photos_export</p></li>
<li><p>timeout: (int, default=120) timeout in seconds used with use_photos_export</p></li>
<li><p>exiftool: (bool, default = False) if True, will use <a class="reference external" href="https://exiftool.org/">exiftool</a> to write metadata directly to the exported photo; exiftool must be installed and in the system path</p></li>
<li><p>use_albums_as_keywords: (bool, default = False); if True, will use album names as keywords when exporting metadata with exiftool or sidecar</p></li>
Expand Down
3 changes: 2 additions & 1 deletion docs/_modules/osxphotos/_constants.html
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../overview.html">OSXPhotos</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../tutorial.html">OSXPhotos Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../cli.html">OSXPhotos Command Line Interface (CLI)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../template_help.html">OSXPhotos Template System</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../package_overview.html">OSXPhotos Python Package Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../API_README.html">OSXPhotos Python API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../reference.html">OSXPhotos Python Reference</a></li>
Expand Down Expand Up @@ -352,12 +351,14 @@ <h1>Source code for osxphotos._constants</h1><div class="highlight"><pre>
<span class="p">(</span><span class="s2">&quot;12&quot;</span><span class="p">,</span> <span class="s2">&quot;4&quot;</span><span class="p">),</span>
<span class="p">(</span><span class="s2">&quot;12&quot;</span><span class="p">,</span> <span class="s2">&quot;5&quot;</span><span class="p">),</span>
<span class="p">(</span><span class="s2">&quot;12&quot;</span><span class="p">,</span> <span class="s2">&quot;6&quot;</span><span class="p">),</span>
<span class="p">(</span><span class="s2">&quot;12&quot;</span><span class="p">,</span> <span class="s2">&quot;7&quot;</span><span class="p">),</span>
<span class="p">(</span><span class="s2">&quot;13&quot;</span><span class="p">,</span> <span class="s2">&quot;0&quot;</span><span class="p">),</span>
<span class="p">(</span><span class="s2">&quot;13&quot;</span><span class="p">,</span> <span class="s2">&quot;1&quot;</span><span class="p">),</span>
<span class="p">(</span><span class="s2">&quot;13&quot;</span><span class="p">,</span> <span class="s2">&quot;2&quot;</span><span class="p">),</span>
<span class="p">(</span><span class="s2">&quot;13&quot;</span><span class="p">,</span> <span class="s2">&quot;3&quot;</span><span class="p">),</span>
<span class="p">(</span><span class="s2">&quot;13&quot;</span><span class="p">,</span> <span class="s2">&quot;4&quot;</span><span class="p">),</span>
<span class="p">(</span><span class="s2">&quot;13&quot;</span><span class="p">,</span> <span class="s2">&quot;5&quot;</span><span class="p">),</span>
<span class="p">(</span><span class="s2">&quot;13&quot;</span><span class="p">,</span> <span class="s2">&quot;6&quot;</span><span class="p">),</span>
<span class="p">(</span><span class="s2">&quot;14&quot;</span><span class="p">,</span> <span class="s2">&quot;0&quot;</span><span class="p">),</span>
<span class="p">]</span>

Expand Down
8 changes: 4 additions & 4 deletions docs/_modules/osxphotos/personinfo.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../genindex.html" /><link rel="search" title="Search" href="../../search.html" />

<!-- Generated with Sphinx 7.2.6 and Furo 2023.09.10 -->
<title>osxphotos.personinfo - osxphotos 0.64.2 documentation</title>
<title>osxphotos.personinfo - osxphotos 0.64.3 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=135e06be" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
Expand Down Expand Up @@ -123,7 +123,7 @@
</label>
</div>
<div class="header-center">
<a href="../../index.html"><div class="brand">osxphotos 0.64.2 documentation</div></a>
<a href="../../index.html"><div class="brand">osxphotos 0.64.3 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -146,7 +146,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="../../index.html">


<span class="sidebar-brand-text">osxphotos 0.64.2 documentation</span>
<span class="sidebar-brand-text">osxphotos 0.64.3 documentation</span>

</a><form class="sidebar-search-container" method="get" action="../../search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -741,7 +741,7 @@ <h1>Source code for osxphotos.personinfo</h1><div class="highlight"><pre>

</aside>
</div>
</div><script src="../../_static/documentation_options.js?v=7190b053"></script>
</div><script src="../../_static/documentation_options.js?v=d5e8344a"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/scripts/furo.js?v=32e29ea5"></script>
Expand Down
8 changes: 4 additions & 4 deletions docs/_modules/osxphotos/photoexporter.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="../../genindex.html" /><link rel="search" title="Search" href="../../search.html" />

<!-- Generated with Sphinx 7.2.6 and Furo 2023.09.10 -->
<title>osxphotos.photoexporter - osxphotos 0.64.2 documentation</title>
<title>osxphotos.photoexporter - osxphotos 0.64.3 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=135e06be" />
<link rel="stylesheet" type="text/css" href="../../_static/copybutton.css?v=76b2166b" />
Expand Down Expand Up @@ -123,7 +123,7 @@
</label>
</div>
<div class="header-center">
<a href="../../index.html"><div class="brand">osxphotos 0.64.2 documentation</div></a>
<a href="../../index.html"><div class="brand">osxphotos 0.64.3 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
Expand All @@ -146,7 +146,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="../../index.html">


<span class="sidebar-brand-text">osxphotos 0.64.2 documentation</span>
<span class="sidebar-brand-text">osxphotos 0.64.3 documentation</span>

</a><form class="sidebar-search-container" method="get" action="../../search.html" role="search">
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
Expand Down Expand Up @@ -1556,7 +1556,7 @@ <h1>Source code for osxphotos.photoexporter</h1><div class="highlight"><pre>

</aside>
</div>
</div><script src="../../_static/documentation_options.js?v=7190b053"></script>
</div><script src="../../_static/documentation_options.js?v=d5e8344a"></script>
<script src="../../_static/doctools.js?v=888ff710"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/scripts/furo.js?v=32e29ea5"></script>
Expand Down
1 change: 0 additions & 1 deletion docs/_modules/osxphotos/photosdb/photosdb.html
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,6 @@
<li class="toctree-l1"><a class="reference internal" href="../../../overview.html">OSXPhotos</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../tutorial.html">OSXPhotos Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../cli.html">OSXPhotos Command Line Interface (CLI)</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../template_help.html">OSXPhotos Template System</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../package_overview.html">OSXPhotos Python Package Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../API_README.html">OSXPhotos Python API</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../reference.html">OSXPhotos Python Reference</a></li>
Expand Down
5 changes: 2 additions & 3 deletions docs/_sources/API_README.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -1644,7 +1644,7 @@ Returns a dictionary representation of all photo info.
``export()``
~~~~~~~~~~~~~~~~

``export(dest, filename=None, edited=False, live_photo=False, export_as_hardlink=False, overwrite=False, increment=True, sidecar_json=False, sidecar_exiftool=False, sidecar_xmp=False, download_missing=False, use_photos_export=False, use_photokit=True, timeout=120, exiftool=False, use_albums_as_keywords=False, use_persons_as_keywords=False)``
``export(dest, filename=None, edited=False, live_photo=False, export_as_hardlink=False, overwrite=False, increment=True, sidecar_json=False, sidecar_exiftool=False, sidecar_xmp=False, use_photos_export=False, use_photokit=True, timeout=120, exiftool=False, use_albums_as_keywords=False, use_persons_as_keywords=False)``

Export photo from the Photos library to another destination on disk.

Expand All @@ -1661,8 +1661,7 @@ Export photo from the Photos library to another destination on disk.
* sidecar_exiftool: (bool, default = False); if True will also write a json sidecar with metadata in format readable by exiftool; sidecar filename will be dest/filename.json where filename is the stem of the photo name; resulting json file will not include tag group names (e.g. ``exiftool -j``\ )
* sidecar_xmp: (bool, default = False); if True will also write a XMP sidecar with metadata; sidecar filename will be dest/filename.xmp where filename is the stem of the photo name
* use_photos_export: (bool, default=False); if True will attempt to export photo via AppleScript or PhotoKit interaction with Photos
* download_missing: (bool, default=False); if True will attempt to export photo via AppleScript or PhotoKit interaction with Photos if missing
* use_photokit: (bool, default=True); if True will attempt to export photo via photokit instead of AppleScript when used with use_photos_export or download_missing
* use_photokit: (bool, default=True); if True will attempt to export photo via photokit instead of AppleScript when used with use_photos_export
* timeout: (int, default=120) timeout in seconds used with use_photos_export
* exiftool: (bool, default = False) if True, will use `exiftool <https://exiftool.org/>`_ to write metadata directly to the exported photo; exiftool must be installed and in the system path
* use_albums_as_keywords: (bool, default = False); if True, will use album names as keywords when exporting metadata with exiftool or sidecar
Expand Down
Loading

0 comments on commit 5ebf6dd

Please sign in to comment.