Added JSON, SQLite report formats, added command

This commit is contained in:
Rhet Turnbull
2022-05-15 09:48:55 -07:00
parent 470839ba0d
commit 1173b6c0f2
25 changed files with 754 additions and 397 deletions

View File

@@ -6,7 +6,7 @@
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="OSXPhotos Template System" href="template_help.html" /><link rel="prev" title="OSXPhotos Tutorial" href="tutorial.html" />
<meta name="generator" content="sphinx-4.4.0, furo 2022.04.07"/>
<title>OSXPhotos Command Line Interface (CLI) - osxphotos 0.48.8 documentation</title>
<title>OSXPhotos Command Line Interface (CLI) - osxphotos 0.49.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=68f4518137b9aefe99b631505a2064c3c42c9852" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css" />
@@ -124,7 +124,7 @@
</label>
</div>
<div class="header-center">
<a href="index.html"><div class="brand">osxphotos 0.48.8 documentation</div></a>
<a href="index.html"><div class="brand">osxphotos 0.49.0 documentation</div></a>
</div>
<div class="header-right">
<div class="theme-toggle-container theme-toggle-header">
@@ -147,7 +147,7 @@
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
<span class="sidebar-brand-text">osxphotos 0.48.8 documentation</span>
<span class="sidebar-brand-text">osxphotos 0.49.0 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">
@@ -1009,7 +1009,12 @@ to modify this behavior.</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-report">
<span class="sig-name descname"><span class="pre">--report</span></span><span class="sig-prename descclassname"> <span class="pre">&lt;REPORT_FILE&gt;</span></span><a class="headerlink" href="#cmdoption-osxphotos-export-report" title="Permalink to this definition">#</a></dt>
<dd><p>Write a CSV formatted report of all files that were exported.</p>
<dd><p>Write a report of all files that were exported. The extension of the report filename will be used to determine the format. Valid extensions are: .csv (CSV file), .json (JSON), .db and .sqlite (SQLite database). REPORT_FILE may be a template string (see Templating System), for example, report export_{today.date}.csv will write a CSV report file named with todays date. See also append.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-append">
<span class="sig-name descname"><span class="pre">--append</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-export-append" title="Permalink to this definition">#</a></dt>
<dd><p>If used with report, add data to existing report file instead of overwriting it. See also report.</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-export-cleanup">
@@ -2104,16 +2109,28 @@ if more than one option is provided, they are treated as “AND”
</section>
<section id="osxphotos-run">
<h3>run<a class="headerlink" href="#osxphotos-run" title="Permalink to this headline">#</a></h3>
<p>Run a python file using same environment as osxphotos</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos run <span class="o">[</span>OPTIONS<span class="o">]</span> PYTHON_FILE
<p>Run a python file using same environment as osxphotos.
Any args are made available to the python file.</p>
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>osxphotos run <span class="o">[</span>OPTIONS<span class="o">]</span> PYTHON_FILE ARGS
</pre></div>
</div>
<p class="rubric">Options</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-run-h">
<span id="cmdoption-osxphotos-run-help"></span><span class="sig-name descname"><span class="pre">-h</span></span><span class="sig-prename descclassname"></span><span class="sig-prename descclassname"><span class="pre">,</span> </span><span class="sig-name descname"><span class="pre">--help</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-run-h" title="Permalink to this definition">#</a></dt>
<dd><p>Show this message and exit</p>
</dd></dl>
<p class="rubric">Arguments</p>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-run-arg-PYTHON_FILE">
<span id="cmdoption-osxphotos-run-arg-python-file"></span><span class="sig-name descname"><span class="pre">PYTHON_FILE</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-run-arg-PYTHON_FILE" title="Permalink to this definition">#</a></dt>
<dd><p>Required argument</p>
</dd></dl>
<dl class="std option">
<dt class="sig sig-object std" id="cmdoption-osxphotos-run-arg-ARGS">
<span id="cmdoption-osxphotos-run-arg-args"></span><span class="sig-name descname"><span class="pre">ARGS</span></span><span class="sig-prename descclassname"></span><a class="headerlink" href="#cmdoption-osxphotos-run-arg-ARGS" title="Permalink to this definition">#</a></dt>
<dd><p>Optional argument(s)</p>
</dd></dl>
</section>
<section id="osxphotos-snap">
<h3>snap<a class="headerlink" href="#osxphotos-snap" title="Permalink to this headline">#</a></h3>