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

Updated docs

Browse Source
This commit is contained in:
Rhet Turnbull
2021-09-12 17:31:15 -07:00
parent 3cd26e2e38
commit 773dca8494
18 changed files with 118 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/reference.html
View File

@@ -5,7 +5,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>osxphotos package &#8212; osxphotos 0.42.69 documentation</title>
<title>osxphotos package &#8212; osxphotos 0.42.80 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
@@ -256,7 +256,7 @@ Returns photos regardless of intrash state.</p>
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotosDB.query">
<span class="sig-name descname"><span class="pre">query</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">osxphotos.queryoptions.QueryOptions</span></span></em><span class="sig-paren">)</span> &#x2192; <span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.PhotoInfo" title="osxphotos.photoinfo.photoinfo.PhotoInfo"><span class="pre">osxphotos.photoinfo.photoinfo.PhotoInfo</span></a><span class="p"><span class="pre">]</span></span><a class="reference internal" href="_modules/osxphotos/photosdb/photosdb.html#PhotosDB.query"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosDB.query" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">query</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">options</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">osxphotos.queryoptions.QueryOptions</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#osxphotos.PhotoInfo" title="osxphotos.photoinfo.photoinfo.PhotoInfo"><span class="pre">osxphotos.photoinfo.photoinfo.PhotoInfo</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/osxphotos/photosdb/photosdb.html#PhotosDB.query"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#osxphotos.PhotosDB.query" title="Permalink to this definition"></a></dt>
<dd><p>Run a query against PhotosDB to extract the photos based on user supplied options</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters</dt>
@@ -845,7 +845,7 @@ render_options: an optional osxphotos.phototemplate.RenderOptions instance with
<dl class="py method">
<dt class="sig sig-object py" id="osxphotos.PhotoInfo.export2">
<span class="sig-name descname"><span class="pre">export2</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">dest</span></em>, <em class="sig-param"><span class="pre">original=True</span></em>, <em class="sig-param"><span class="pre">original_filename=None</span></em>, <em class="sig-param"><span class="pre">edited=False</span></em>, <em class="sig-param"><span class="pre">edited_filename=None</span></em>, <em class="sig-param"><span class="pre">live_photo=False</span></em>, <em class="sig-param"><span class="pre">raw_photo=False</span></em>, <em class="sig-param"><span class="pre">export_as_hardlink=False</span></em>, <em class="sig-param"><span class="pre">overwrite=False</span></em>, <em class="sig-param"><span class="pre">increment=True</span></em>, <em class="sig-param"><span class="pre">sidecar=0</span></em>, <em class="sig-param"><span class="pre">sidecar_drop_ext=False</span></em>, <em class="sig-param"><span class="pre">use_photos_export=False</span></em>, <em class="sig-param"><span class="pre">timeout=120</span></em>, <em class="sig-param"><span class="pre">exiftool=False</span></em>, <em class="sig-param"><span class="pre">use_albums_as_keywords=False</span></em>, <em class="sig-param"><span class="pre">use_persons_as_keywords=False</span></em>, <em class="sig-param"><span class="pre">keyword_template=None</span></em>, <em class="sig-param"><span class="pre">description_template=None</span></em>, <em class="sig-param"><span class="pre">update=False</span></em>, <em class="sig-param"><span class="pre">ignore_signature=False</span></em>, <em class="sig-param"><span class="pre">export_db=None</span></em>, <em class="sig-param"><span class="pre">fileutil=&lt;class</span> <span class="pre">'osxphotos.fileutil.FileUtil'&gt;</span></em>, <em class="sig-param"><span class="pre">dry_run=False</span></em>, <em class="sig-param"><span class="pre">touch_file=False</span></em>, <em class="sig-param"><span class="pre">convert_to_jpeg=False</span></em>, <em class="sig-param"><span class="pre">jpeg_quality=1.0</span></em>, <em class="sig-param"><span class="pre">ignore_date_modified=False</span></em>, <em class="sig-param"><span class="pre">use_photokit=False</span></em>, <em class="sig-param"><span class="pre">verbose=None</span></em>, <em class="sig-param"><span class="pre">exiftool_flags=None</span></em>, <em class="sig-param"><span class="pre">merge_exif_keywords=False</span></em>, <em class="sig-param"><span class="pre">merge_exif_persons=False</span></em>, <em class="sig-param"><span class="pre">jpeg_ext=None</span></em>, <em class="sig-param"><span class="pre">persons=True</span></em>, <em class="sig-param"><span class="pre">location=True</span></em>, <em class="sig-param"><span class="pre">replace_keywords=False</span></em>, <em class="sig-param"><span class="pre">preview=False</span></em>, <em class="sig-param"><span class="pre">preview_suffix='_preview'</span></em>, <em class="sig-param"><span class="pre">render_options:</span> <span class="pre">Optional[osxphotos.phototemplate.RenderOptions]</span> <span class="pre">=</span> <span class="pre">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#osxphotos.PhotoInfo.export2" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">export2</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="pre">dest</span></em>, <em class="sig-param"><span class="pre">original=True</span></em>, <em class="sig-param"><span class="pre">original_filename=None</span></em>, <em class="sig-param"><span class="pre">edited=False</span></em>, <em class="sig-param"><span class="pre">edited_filename=None</span></em>, <em class="sig-param"><span class="pre">live_photo=False</span></em>, <em class="sig-param"><span class="pre">raw_photo=False</span></em>, <em class="sig-param"><span class="pre">export_as_hardlink=False</span></em>, <em class="sig-param"><span class="pre">overwrite=False</span></em>, <em class="sig-param"><span class="pre">increment=True</span></em>, <em class="sig-param"><span class="pre">sidecar=0</span></em>, <em class="sig-param"><span class="pre">sidecar_drop_ext=False</span></em>, <em class="sig-param"><span class="pre">use_photos_export=False</span></em>, <em class="sig-param"><span class="pre">timeout=120</span></em>, <em class="sig-param"><span class="pre">exiftool=False</span></em>, <em class="sig-param"><span class="pre">use_albums_as_keywords=False</span></em>, <em class="sig-param"><span class="pre">use_persons_as_keywords=False</span></em>, <em class="sig-param"><span class="pre">keyword_template=None</span></em>, <em class="sig-param"><span class="pre">description_template=None</span></em>, <em class="sig-param"><span class="pre">update=False</span></em>, <em class="sig-param"><span class="pre">ignore_signature=False</span></em>, <em class="sig-param"><span class="pre">export_db=None</span></em>, <em class="sig-param"><span class="pre">fileutil=&lt;class</span> <span class="pre">'osxphotos.fileutil.FileUtil'&gt;</span></em>, <em class="sig-param"><span class="pre">dry_run=False</span></em>, <em class="sig-param"><span class="pre">touch_file=False</span></em>, <em class="sig-param"><span class="pre">convert_to_jpeg=False</span></em>, <em class="sig-param"><span class="pre">jpeg_quality=1.0</span></em>, <em class="sig-param"><span class="pre">ignore_date_modified=False</span></em>, <em class="sig-param"><span class="pre">use_photokit=False</span></em>, <em class="sig-param"><span class="pre">verbose=None</span></em>, <em class="sig-param"><span class="pre">exiftool_flags=None</span></em>, <em class="sig-param"><span class="pre">merge_exif_keywords=False</span></em>, <em class="sig-param"><span class="pre">merge_exif_persons=False</span></em>, <em class="sig-param"><span class="pre">jpeg_ext=None</span></em>, <em class="sig-param"><span class="pre">persons=True</span></em>, <em class="sig-param"><span class="pre">location=True</span></em>, <em class="sig-param"><span class="pre">replace_keywords=False</span></em>, <em class="sig-param"><span class="pre">preview=False</span></em>, <em class="sig-param"><span class="pre">preview_suffix='_preview'</span></em>, <em class="sig-param"><span class="pre">render_options:</span> <span class="pre">Optional[osxphotos.phototemplate.RenderOptions]</span> <span class="pre">=</span> <span class="pre">None</span></em>, <em class="sig-param"><span class="pre">strip=False</span></em><span class="sig-paren">)</span><a class="headerlink" href="#osxphotos.PhotoInfo.export2" title="Permalink to this definition"></a></dt>
<dd><p>export photo, like export but with update and dry_run options
dest: must be valid destination path or exception raised
filename: (optional): name of exported picture; if not provided, will use current filename</p>
@@ -914,7 +914,8 @@ location: if True, include location in exported metadata
replace_keywords: if True, keyword_template replaces any keywords, otherwise it’s additive
preview: if True, also exports preview image
preview_suffix: optional string to append to end of filename for preview images
render_options: optional osxphotos.phototemplate.RenderOptions instance to specify options for rendering templates</p>
render_options: optional osxphotos.phototemplate.RenderOptions instance to specify options for rendering templates
strip: if True, strip whitespace from rendered templates</p>
<dl class="simple">
<dt>Returns: ExportResults class</dt><dd><p>ExportResults has attributes:
“exported”,
@@ -1396,7 +1397,7 @@ Returns None if no associated RAW image</p>
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
@@ -1418,7 +1419,7 @@ Returns None if no associated RAW image</p>
&copy;2021, Rhet Turnbull.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.2</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.2.0</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|