Skip to content

Commit

Permalink
Added getVersion to Python and updated docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
ggarra13 committed Oct 9, 2023
1 parent 29c8cac commit fb76da5
Show file tree
Hide file tree
Showing 13 changed files with 76 additions and 38 deletions.
2 changes: 2 additions & 0 deletions mrv2/docs/en/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,8 @@ <h2 id="G">G</h2>
<li><a href="python_api/mrv2.html#mrv2.Path.getNumber">getNumber() (mrv2.Path method)</a>
</li>
<li><a href="python_api/mrv2.html#mrv2.Path.getPadding">getPadding() (mrv2.Path method)</a>
</li>
<li><a href="python_api/cmd.html#mrv2.cmd.getVersion">getVersion() (in module mrv2.cmd)</a>
</li>
</ul></td>
</tr></table>
Expand Down
Binary file modified mrv2/docs/en/objects.inv
Binary file not shown.
7 changes: 7 additions & 0 deletions mrv2/docs/en/python_api/cmd.html
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
<li class="toctree-l3"><a class="reference internal" href="#mrv2.cmd.displayOptions"><code class="docutils literal notranslate"><span class="pre">displayOptions()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.cmd.environmentMapOptions"><code class="docutils literal notranslate"><span class="pre">environmentMapOptions()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.cmd.getLayers"><code class="docutils literal notranslate"><span class="pre">getLayers()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.cmd.getVersion"><code class="docutils literal notranslate"><span class="pre">getVersion()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.cmd.imageOptions"><code class="docutils literal notranslate"><span class="pre">imageOptions()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.cmd.isMuted"><code class="docutils literal notranslate"><span class="pre">isMuted()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.cmd.lutOptions"><code class="docutils literal notranslate"><span class="pre">lutOptions()</span></code></a></li>
Expand Down Expand Up @@ -177,6 +178,12 @@
<dd><p>Get the layers of the timeline (GUI).</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="mrv2.cmd.getVersion">
<span class="sig-prename descclassname"><span class="pre">mrv2.cmd.</span></span><span class="sig-name descname"><span class="pre">getVersion</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#mrv2.cmd.getVersion" title="Link to this definition"></a></dt>
<dd><p>Get the version of mrv2.</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="mrv2.cmd.imageOptions">
<span class="sig-prename descclassname"><span class="pre">mrv2.cmd.</span></span><span class="sig-name descname"><span class="pre">imageOptions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="image.html#mrv2.image.ImageOptions" title="mrv2.image.ImageOptions"><span class="pre">mrv2.image.ImageOptions</span></a></span></span><a class="headerlink" href="#mrv2.cmd.imageOptions" title="Link to this definition"></a></dt>
Expand Down
1 change: 1 addition & 0 deletions mrv2/docs/en/python_api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@
<li class="toctree-l2"><a class="reference internal" href="cmd.html#mrv2.cmd.displayOptions"><code class="docutils literal notranslate"><span class="pre">displayOptions()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="cmd.html#mrv2.cmd.environmentMapOptions"><code class="docutils literal notranslate"><span class="pre">environmentMapOptions()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="cmd.html#mrv2.cmd.getLayers"><code class="docutils literal notranslate"><span class="pre">getLayers()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="cmd.html#mrv2.cmd.getVersion"><code class="docutils literal notranslate"><span class="pre">getVersion()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="cmd.html#mrv2.cmd.imageOptions"><code class="docutils literal notranslate"><span class="pre">imageOptions()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="cmd.html#mrv2.cmd.isMuted"><code class="docutils literal notranslate"><span class="pre">isMuted()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="cmd.html#mrv2.cmd.lutOptions"><code class="docutils literal notranslate"><span class="pre">lutOptions()</span></code></a></li>
Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/en/searchindex.js

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions mrv2/docs/es/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -306,6 +306,8 @@ <h2 id="G">G</h2>
<li><a href="python_api/mrv2.html#mrv2.Path.getNumber">getNumber() (método de mrv2.Path)</a>
</li>
<li><a href="python_api/mrv2.html#mrv2.Path.getPadding">getPadding() (método de mrv2.Path)</a>
</li>
<li><a href="python_api/cmd.html#mrv2.cmd.getVersion">getVersion() (en el módulo mrv2.cmd)</a>
</li>
</ul></td>
</tr></table>
Expand Down
Binary file modified mrv2/docs/es/objects.inv
Binary file not shown.
7 changes: 7 additions & 0 deletions mrv2/docs/es/python_api/cmd.html
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@
<li class="toctree-l3"><a class="reference internal" href="#mrv2.cmd.displayOptions"><code class="docutils literal notranslate"><span class="pre">displayOptions()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.cmd.environmentMapOptions"><code class="docutils literal notranslate"><span class="pre">environmentMapOptions()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.cmd.getLayers"><code class="docutils literal notranslate"><span class="pre">getLayers()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.cmd.getVersion"><code class="docutils literal notranslate"><span class="pre">getVersion()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.cmd.imageOptions"><code class="docutils literal notranslate"><span class="pre">imageOptions()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.cmd.isMuted"><code class="docutils literal notranslate"><span class="pre">isMuted()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#mrv2.cmd.lutOptions"><code class="docutils literal notranslate"><span class="pre">lutOptions()</span></code></a></li>
Expand Down Expand Up @@ -177,6 +178,12 @@
<dd><p>Obtener las capas de la línea de tiempo (GUI).</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="mrv2.cmd.getVersion">
<span class="sig-prename descclassname"><span class="pre">mrv2.cmd.</span></span><span class="sig-name descname"><span class="pre">getVersion</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#mrv2.cmd.getVersion" title="Link to this definition"></a></dt>
<dd><p>Retorna la versión de mrv2.</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="mrv2.cmd.imageOptions">
<span class="sig-prename descclassname"><span class="pre">mrv2.cmd.</span></span><span class="sig-name descname"><span class="pre">imageOptions</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="image.html#mrv2.image.ImageOptions" title="mrv2.image.ImageOptions"><span class="pre">mrv2.image.ImageOptions</span></a></span></span><a class="headerlink" href="#mrv2.cmd.imageOptions" title="Link to this definition"></a></dt>
Expand Down
1 change: 1 addition & 0 deletions mrv2/docs/es/python_api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@
<li class="toctree-l2"><a class="reference internal" href="cmd.html#mrv2.cmd.displayOptions"><code class="docutils literal notranslate"><span class="pre">displayOptions()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="cmd.html#mrv2.cmd.environmentMapOptions"><code class="docutils literal notranslate"><span class="pre">environmentMapOptions()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="cmd.html#mrv2.cmd.getLayers"><code class="docutils literal notranslate"><span class="pre">getLayers()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="cmd.html#mrv2.cmd.getVersion"><code class="docutils literal notranslate"><span class="pre">getVersion()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="cmd.html#mrv2.cmd.imageOptions"><code class="docutils literal notranslate"><span class="pre">imageOptions()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="cmd.html#mrv2.cmd.isMuted"><code class="docutils literal notranslate"><span class="pre">isMuted()</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="cmd.html#mrv2.cmd.lutOptions"><code class="docutils literal notranslate"><span class="pre">lutOptions()</span></code></a></li>
Expand Down
2 changes: 1 addition & 1 deletion mrv2/docs/es/searchindex.js

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions mrv2/lib/mrvPy/Cmds.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,11 @@ namespace mrv2
{
using namespace mrv;

std::string getVersion()
{
return mrv::version();
}

/**
* \brief Open a file with optiona audio.
*
Expand Down Expand Up @@ -502,10 +507,14 @@ Used to run main commands and get and set the display, image, compare, LUT optio
cmds.def(
"setStereo3DOptions", &mrv2::cmd::setStereo3DOptions,
_("Set the stereo 3D options."), py::arg("options"));

cmds.def(
"getLayers", &mrv2::cmd::getLayers,
_("Get the layers of the timeline (GUI)."));

cmds.def(
"getVersion", &mrv2::cmd::getVersion, _("Get the version of mrv2."));

cmds.def(
"update", &mrv2::cmd::update,
_("Call Fl::check to update the GUI and return the number of seconds "
Expand Down
13 changes: 9 additions & 4 deletions mrv2/po/es.po
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: mrv2 v0.7.7\n"
"Report-Msgid-Bugs-To: [email protected]\n"
"POT-Creation-Date: 2023-10-09 15:32-0300\n"
"POT-Creation-Date: 2023-10-09 17:14-0300\n"
"PO-Revision-Date: 2023-02-11 13:42-0300\n"
"Last-Translator: Gonzalo Garramuño <[email protected]>\n"
"Language-Team: Spanish <[email protected]>\n"
Expand Down Expand Up @@ -1931,7 +1931,9 @@ msgid ""
"Expected a handle to a Python function or to a tuple containing a Python "
"function and a string with menu options in it."
msgstr ""
"Se esperaba un identificador para una función de Python o para una tupla que contiene una función de Python y una cadena de texto con opciones de menú, como __divider__."
"Se esperaba un identificador para una función de Python o para una tupla que "
"contiene una función de Python y una cadena de texto con opciones de menú, "
"como __divider__."

msgid ""
"Expected a tuple containing a Python function and a string with menu options "
Expand Down Expand Up @@ -2264,6 +2266,9 @@ msgstr "Obtener las capas de la línea de tiempo (GUI)."
msgid "Get the playback volume."
msgstr "Obtenga el volumen de reproducción."

msgid "Get the version of mrv2."
msgstr "Retorna la versión de mrv2."

msgid "Ghosting"
msgstr "Fanstasma"

Expand Down Expand Up @@ -2446,8 +2451,8 @@ msgid ""
"In '{0}' expected a function a tuple containing a Python function and a "
"string with menu options in it."
msgstr ""
"En '{0}' experaba un tuple conteniendo una función de Python y una cadena "
"de texto con opciones de menú en ella."
"En '{0}' experaba un tuple conteniendo una función de Python y una cadena de "
"texto con opciones de menú en ella."

msgid ""
"In '{0}' expected a function as a value or a tuple containing a Python "
Expand Down
68 changes: 36 additions & 32 deletions mrv2/po/messages.pot
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: mrv2 v0.8.0\n"
"Report-Msgid-Bugs-To: [email protected]\n"
"POT-Creation-Date: 2023-10-09 15:32-0300\n"
"POT-Creation-Date: 2023-10-09 17:14-0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <[email protected]>\n"
Expand Down Expand Up @@ -87,7 +87,7 @@ msgid ""
":attr:`start_time`/:attr:`end_time_exclusive` and bound arguments.\n"
msgstr ""

#: mrvPy/Cmds.cpp:432
#: mrvPy/Cmds.cpp:435
msgid ""
"\n"
"Command module.\n"
Expand Down Expand Up @@ -1244,7 +1244,7 @@ msgid ""
"calculate the Read Ahead and Read Behind"
msgstr ""

#: mrvPy/Cmds.cpp:513
#: mrvPy/Cmds.cpp:520
msgid ""
"Call Fl::check to update the GUI and return the number of seconds that "
"elapsed."
Expand Down Expand Up @@ -1397,7 +1397,7 @@ msgstr ""
msgid "Close Current"
msgstr ""

#: mrvPy/Cmds.cpp:451
#: mrvPy/Cmds.cpp:454
msgid "Close all file items."
msgstr ""

Expand All @@ -1421,7 +1421,7 @@ msgstr ""
msgid "Close the current A file."
msgstr ""

#: mrvPy/Cmds.cpp:448
#: mrvPy/Cmds.cpp:451
msgid "Close the file item."
msgstr ""

Expand Down Expand Up @@ -1541,7 +1541,7 @@ msgstr ""
msgid "Compare the A and B files side by side"
msgstr ""

#: mrvPy/Cmds.cpp:444
#: mrvPy/Cmds.cpp:447
msgid "Compare two file items with a compare mode."
msgstr ""

Expand Down Expand Up @@ -2566,14 +2566,18 @@ msgstr ""
msgid "Get maximum file sequence digits."
msgstr ""

#: mrvPy/Cmds.cpp:509
#: mrvPy/Cmds.cpp:513
msgid "Get the layers of the timeline (GUI)."
msgstr ""

#: mrvPy/Cmds.cpp:523
#: mrvPy/Cmds.cpp:530
msgid "Get the playback volume."
msgstr ""

#: mrvPy/Cmds.cpp:516
msgid "Get the version of mrv2."
msgstr ""

#: mrvPanels/mrvAnnotationsPanel.cpp:307
msgid "Ghosting"
msgstr ""
Expand Down Expand Up @@ -3401,7 +3405,7 @@ msgstr ""
msgid "No playlist selected."
msgstr ""

#: mrvPy/Cmds.cpp:402
#: mrvPy/Cmds.cpp:405
msgid "No session name established, cannot save."
msgstr ""

Expand Down Expand Up @@ -3584,11 +3588,11 @@ msgstr ""
msgid "Open a filename with audio"
msgstr ""

#: mrvPy/Cmds.cpp:555
#: mrvPy/Cmds.cpp:562
msgid "Open a session file."
msgstr ""

#: mrvPy/Cmds.cpp:439
#: mrvPy/Cmds.cpp:442
msgid "Open file with optional audio."
msgstr ""

Expand Down Expand Up @@ -4427,19 +4431,19 @@ msgstr ""
msgid "Return the A file item."
msgstr ""

#: mrvPy/Cmds.cpp:470
#: mrvPy/Cmds.cpp:473
msgid "Return the LUT options."
msgstr ""

#: mrvPy/Cmds.cpp:463
#: mrvPy/Cmds.cpp:466
msgid "Return the display options."
msgstr ""

#: mrvPy/Cmds.cpp:486
#: mrvPy/Cmds.cpp:489
msgid "Return the environment map options."
msgstr ""

#: mrvPy/Cmds.cpp:478
#: mrvPy/Cmds.cpp:481
msgid "Return the image options."
msgstr ""

Expand All @@ -4455,19 +4459,19 @@ msgstr ""
msgid "Return the list of layers."
msgstr ""

#: mrvPy/Cmds.cpp:459
#: mrvPy/Cmds.cpp:462
msgid "Return the path to preferences of mrv2."
msgstr ""

#: mrvPy/Cmds.cpp:455
#: mrvPy/Cmds.cpp:458
msgid "Return the root path to the insallation of mrv2."
msgstr ""

#: mrvApp/App.cpp:383
msgid "Return the version and exit."
msgstr ""

#: mrvPy/Cmds.cpp:548
#: mrvPy/Cmds.cpp:555
msgid "Returns current session file."
msgstr ""

Expand Down Expand Up @@ -4497,7 +4501,7 @@ msgstr ""
msgid "Returns the time value for time converted to new_rate."
msgstr ""

#: mrvPy/Cmds.cpp:517
#: mrvPy/Cmds.cpp:524
msgid "Returns true if audio is muted."
msgstr ""

Expand Down Expand Up @@ -4638,19 +4642,19 @@ msgstr ""
msgid "Save Single Frame"
msgstr ""

#: mrvPy/Cmds.cpp:542
#: mrvPy/Cmds.cpp:549
msgid "Save a PDF document with all annotations and notes."
msgstr ""

#: mrvPy/Cmds.cpp:531
#: mrvPy/Cmds.cpp:538
msgid "Save a movie or sequence from the front layer."
msgstr ""

#: mrvPy/Cmds.cpp:558 mrvPy/Cmds.cpp:561
#: mrvPy/Cmds.cpp:565 mrvPy/Cmds.cpp:568
msgid "Save a session file."
msgstr ""

#: mrvPy/Cmds.cpp:536
#: mrvPy/Cmds.cpp:543
msgid "Save an .otio file from the current selected image."
msgstr ""

Expand Down Expand Up @@ -4991,31 +4995,31 @@ msgstr ""
msgid "Set the A file index."
msgstr ""

#: mrvPy/Cmds.cpp:473
#: mrvPy/Cmds.cpp:476
msgid "Set the LUT options."
msgstr ""

#: mrvPy/Settings.cpp:402
msgid "Set the cache memory setting in gigabytes."
msgstr ""

#: mrvPy/Cmds.cpp:498
#: mrvPy/Cmds.cpp:501
msgid "Set the compare options."
msgstr ""

#: mrvPy/Cmds.cpp:467
#: mrvPy/Cmds.cpp:470
msgid "Set the display options."
msgstr ""

#: mrvPy/Cmds.cpp:490
#: mrvPy/Cmds.cpp:493
msgid "Set the environment map options."
msgstr ""

#: mrvPy/FilesModel.cpp:284
msgid "Set the first version for current media."
msgstr ""

#: mrvPy/Cmds.cpp:482
#: mrvPy/Cmds.cpp:485
msgid "Set the image options."
msgstr ""

Expand All @@ -5039,7 +5043,7 @@ msgstr ""
msgid "Set the last version for current media."
msgstr ""

#: mrvPy/Cmds.cpp:520
#: mrvPy/Cmds.cpp:527
msgid "Set the muting of the audio."
msgstr ""

Expand All @@ -5059,7 +5063,7 @@ msgstr ""
msgid "Set the out time of the selected time range of the timeline."
msgstr ""

#: mrvPy/Cmds.cpp:526
#: mrvPy/Cmds.cpp:533
msgid "Set the playback volume."
msgstr ""

Expand All @@ -5071,11 +5075,11 @@ msgstr ""
msgid "Set the selected time range of the timeline."
msgstr ""

#: mrvPy/Cmds.cpp:506
#: mrvPy/Cmds.cpp:509
msgid "Set the stereo 3D options."
msgstr ""

#: mrvPy/Cmds.cpp:552
#: mrvPy/Cmds.cpp:559
msgid "Sets the current session file."
msgstr ""

Expand Down

0 comments on commit fb76da5

Please sign in to comment.