Update documentation

Author: actions-user

_sources/autoapi/dvcurator/gui/index.rst.txt

@@ -10,6 +10,7 @@ Classes
 .. autoapisummary::
 
    dvcurator.gui.redirect_text
+   dvcurator.gui.TokenConfig
    dvcurator.gui.MainApp
 
 
@@ -41,6 +42,29 @@ Module Contents
    .. py:method:: flush()
 
 
+.. py:class:: TokenConfig(parent)
+
+   Bases: :py:obj:`tkinter.Toplevel`
+
+
+   Token configuration window for Dataverse and GitHub tokens
+
+
+   .. py:attribute:: dv_token
+
+
+   .. py:attribute:: gh_token
+
+
+   .. py:attribute:: parent
+
+
+   .. py:method:: save()
+
+
+   .. py:method:: cancel()
+
+
 .. py:class:: MainApp(parent, *args, **kwargs)
 
    Bases: :py:obj:`tkinter.Frame`
@@ -181,6 +205,12 @@ Module Contents
 
 
 
+   .. py:method:: configure_tokens()
+
+      Open the token configuration window
+
+
+
    .. py:attribute:: parent
 
 
@@ -193,6 +223,12 @@ Module Contents
    .. py:attribute:: editmenu
 
 
+   .. py:attribute:: dv_token
+
+
+   .. py:attribute:: gh_token
+
+
    .. py:attribute:: github_org
 
 
@@ -208,18 +244,15 @@ Module Contents
    .. py:attribute:: doi_entry
 
 
-   .. py:attribute:: dv_token
-
-
-   .. py:attribute:: gh_token
-
-
    .. py:attribute:: dropbox
 
 
    .. py:attribute:: dropbox_entry
 
 
+   .. py:attribute:: open_folder_button
+
+
    .. py:attribute:: cite_button
 
 

autoapi/dvcurator/gui/index.html

@@ -41,7 +41,10 @@ <h2>Classes<a class="headerlink" href="#classes" title="Permalink to this headin
 <tr class="row-odd"><td><p><a class="reference internal" href="#dvcurator.gui.redirect_text" title="dvcurator.gui.redirect_text"><code class="xref py py-obj docutils literal notranslate"><span class="pre">redirect_text</span></code></a></p></td>
 <td><p>Redirect standard output to a text box in the GUI</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="#dvcurator.gui.MainApp" title="dvcurator.gui.MainApp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MainApp</span></code></a></p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="#dvcurator.gui.TokenConfig" title="dvcurator.gui.TokenConfig"><code class="xref py py-obj docutils literal notranslate"><span class="pre">TokenConfig</span></code></a></p></td>
+<td><p>Token configuration window for Dataverse and GitHub tokens</p></td>
+</tr>
+<tr class="row-odd"><td><p><a class="reference internal" href="#dvcurator.gui.MainApp" title="dvcurator.gui.MainApp"><code class="xref py py-obj docutils literal notranslate"><span class="pre">MainApp</span></code></a></p></td>
 <td><p>Frame widget which may contain other widgets and can have a 3D border.</p></td>
 </tr>
 </tbody>
@@ -81,6 +84,38 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalin
 
 </dd></dl>
 
+<dl class="py class">
+<dt class="sig sig-object py" id="dvcurator.gui.TokenConfig">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dvcurator.gui.</span></span><span class="sig-name descname"><span class="pre">TokenConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dvcurator.gui.TokenConfig" title="Permalink to this definition">¶</a></dt>
+<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">tkinter.Toplevel</span></code></p>
+<p>Token configuration window for Dataverse and GitHub tokens</p>
+<dl class="py attribute">
+<dt class="sig sig-object py" id="dvcurator.gui.TokenConfig.dv_token">
+<span class="sig-name descname"><span class="pre">dv_token</span></span><a class="headerlink" href="#dvcurator.gui.TokenConfig.dv_token" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="dvcurator.gui.TokenConfig.gh_token">
+<span class="sig-name descname"><span class="pre">gh_token</span></span><a class="headerlink" href="#dvcurator.gui.TokenConfig.gh_token" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="dvcurator.gui.TokenConfig.parent">
+<span class="sig-name descname"><span class="pre">parent</span></span><a class="headerlink" href="#dvcurator.gui.TokenConfig.parent" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="dvcurator.gui.TokenConfig.save">
+<span class="sig-name descname"><span class="pre">save</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dvcurator.gui.TokenConfig.save" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py method">
+<dt class="sig sig-object py" id="dvcurator.gui.TokenConfig.cancel">
+<span class="sig-name descname"><span class="pre">cancel</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dvcurator.gui.TokenConfig.cancel" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+</dd></dl>
+
 <dl class="py class">
 <dt class="sig sig-object py" id="dvcurator.gui.MainApp">
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">dvcurator.gui.</span></span><span class="sig-name descname"><span class="pre">MainApp</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parent</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#dvcurator.gui.MainApp" title="Permalink to this definition">¶</a></dt>
@@ -218,6 +253,12 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalin
 <dd><p>Save config before killing window</p>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="dvcurator.gui.MainApp.configure_tokens">
+<span class="sig-name descname"><span class="pre">configure_tokens</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#dvcurator.gui.MainApp.configure_tokens" title="Permalink to this definition">¶</a></dt>
+<dd><p>Open the token configuration window</p>
+</dd></dl>
+
 <dl class="py attribute">
 <dt class="sig sig-object py" id="dvcurator.gui.MainApp.parent">
 <span class="sig-name descname"><span class="pre">parent</span></span><a class="headerlink" href="#dvcurator.gui.MainApp.parent" title="Permalink to this definition">¶</a></dt>
@@ -238,6 +279,16 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalin
 <span class="sig-name descname"><span class="pre">editmenu</span></span><a class="headerlink" href="#dvcurator.gui.MainApp.editmenu" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
+<dl class="py attribute">
+<dt class="sig sig-object py" id="dvcurator.gui.MainApp.dv_token">
+<span class="sig-name descname"><span class="pre">dv_token</span></span><a class="headerlink" href="#dvcurator.gui.MainApp.dv_token" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
+<dl class="py attribute">
+<dt class="sig sig-object py" id="dvcurator.gui.MainApp.gh_token">
+<span class="sig-name descname"><span class="pre">gh_token</span></span><a class="headerlink" href="#dvcurator.gui.MainApp.gh_token" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="py attribute">
 <dt class="sig sig-object py" id="dvcurator.gui.MainApp.github_org">
 <span class="sig-name descname"><span class="pre">github_org</span></span><a class="headerlink" href="#dvcurator.gui.MainApp.github_org" title="Permalink to this definition">¶</a></dt>
@@ -263,16 +314,6 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalin
 <span class="sig-name descname"><span class="pre">doi_entry</span></span><a class="headerlink" href="#dvcurator.gui.MainApp.doi_entry" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
-<dl class="py attribute">
-<dt class="sig sig-object py" id="dvcurator.gui.MainApp.dv_token">
-<span class="sig-name descname"><span class="pre">dv_token</span></span><a class="headerlink" href="#dvcurator.gui.MainApp.dv_token" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
-<dl class="py attribute">
-<dt class="sig sig-object py" id="dvcurator.gui.MainApp.gh_token">
-<span class="sig-name descname"><span class="pre">gh_token</span></span><a class="headerlink" href="#dvcurator.gui.MainApp.gh_token" title="Permalink to this definition">¶</a></dt>
-<dd></dd></dl>
-
 <dl class="py attribute">
 <dt class="sig sig-object py" id="dvcurator.gui.MainApp.dropbox">
 <span class="sig-name descname"><span class="pre">dropbox</span></span><a class="headerlink" href="#dvcurator.gui.MainApp.dropbox" title="Permalink to this definition">¶</a></dt>
@@ -283,6 +324,11 @@ <h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalin
 <span class="sig-name descname"><span class="pre">dropbox_entry</span></span><a class="headerlink" href="#dvcurator.gui.MainApp.dropbox_entry" title="Permalink to this definition">¶</a></dt>
 <dd></dd></dl>
 
+<dl class="py attribute">
+<dt class="sig sig-object py" id="dvcurator.gui.MainApp.open_folder_button">
+<span class="sig-name descname"><span class="pre">open_folder_button</span></span><a class="headerlink" href="#dvcurator.gui.MainApp.open_folder_button" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
 <dl class="py attribute">
 <dt class="sig sig-object py" id="dvcurator.gui.MainApp.cite_button">
 <span class="sig-name descname"><span class="pre">cite_button</span></span><a class="headerlink" href="#dvcurator.gui.MainApp.cite_button" title="Permalink to this definition">¶</a></dt>

genindex.html

@@ -47,6 +47,7 @@ <h1 id="index">Index</h1>
  | <a href="#Q"><strong>Q</strong></a>
  | <a href="#R"><strong>R</strong></a>
  | <a href="#S"><strong>S</strong></a>
+ | <a href="#T"><strong>T</strong></a>
  | <a href="#V"><strong>V</strong></a>
  | <a href="#W"><strong>W</strong></a>
 
@@ -80,6 +81,8 @@ <h2 id="B">B</h2>
 <h2 id="C">C</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.TokenConfig.cancel">cancel() (dvcurator.gui.TokenConfig method)</a>
+</li>
       <li><a href="autoapi/dvcurator/fs/index.html#dvcurator.fs.check_dropbox">check_dropbox() (in module dvcurator.fs)</a>
 </li>
       <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.MainApp.check_if_done">check_if_done() (dvcurator.gui.MainApp method)</a>
@@ -99,6 +102,8 @@ <h2 id="C">C</h2>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="autoapi/dvcurator/pdf/index.html#dvcurator.pdf.combine_author_names">combine_author_names() (in module dvcurator.pdf)</a>
+</li>
+      <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.MainApp.configure_tokens">configure_tokens() (dvcurator.gui.MainApp method)</a>
 </li>
       <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.MainApp.convert">convert() (dvcurator.gui.MainApp method)</a>
 </li>
@@ -143,7 +148,11 @@ <h2 id="D">D</h2>
       <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.MainApp.dropbox_entry">dropbox_entry (dvcurator.gui.MainApp attribute)</a>
 </li>
       <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.MainApp.dv_token">dv_token (dvcurator.gui.MainApp attribute)</a>
+
+      <ul>
+        <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.TokenConfig.dv_token">(dvcurator.gui.TokenConfig attribute)</a>
 </li>
+      </ul></li>
       <li>
     dvcurator
 
@@ -270,10 +279,14 @@ <h2 id="G">G</h2>
 </li>
       <li><a href="autoapi/dvcurator/dataverse/index.html#dvcurator.dataverse.get_metadata">get_metadata() (in module dvcurator.dataverse)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.MainApp.gh_token">gh_token (dvcurator.gui.MainApp attribute)</a>
+
+      <ul>
+        <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.TokenConfig.gh_token">(dvcurator.gui.TokenConfig attribute)</a>
 </li>
+      </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="autoapi/dvcurator/github/index.html#dvcurator.github.github_api">github_api (in module dvcurator.github)</a>
 
       <ul>
@@ -357,6 +370,8 @@ <h2 id="O">O</h2>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.MainApp.open_folder_button">open_folder_button (dvcurator.gui.MainApp attribute)</a>
+</li>
       <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.MainApp.out">out (dvcurator.gui.MainApp attribute)</a>
 </li>
       <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.redirect_text.output">output (dvcurator.gui.redirect_text attribute)</a>
@@ -368,11 +383,15 @@ <h2 id="P">P</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.MainApp.parent">parent (dvcurator.gui.MainApp attribute)</a>
+
+      <ul>
+        <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.TokenConfig.parent">(dvcurator.gui.TokenConfig attribute)</a>
 </li>
-      <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.MainApp.pb">pb (dvcurator.gui.MainApp attribute)</a>
-</li>
+      </ul></li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.MainApp.pb">pb (dvcurator.gui.MainApp attribute)</a>
+</li>
       <li><a href="autoapi/dvcurator/hosts/index.html#dvcurator.hosts.pkg_repo">pkg_repo (in module dvcurator.hosts)</a>
 </li>
       <li><a href="autoapi/dvcurator/rename/index.html#dvcurator.rename.project_name">project_name() (in module dvcurator.rename)</a>
@@ -417,16 +436,18 @@ <h2 id="R">R</h2>
 <h2 id="S">S</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.TokenConfig.save">save() (dvcurator.gui.TokenConfig method)</a>
+</li>
       <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.MainApp.save_config">save_config() (dvcurator.gui.MainApp method)</a>
 </li>
       <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.MainApp.save_config_as">save_config_as() (dvcurator.gui.MainApp method)</a>
 </li>
       <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.MainApp.schedule_check">schedule_check() (dvcurator.gui.MainApp method)</a>
-</li>
-      <li><a href="autoapi/dvcurator/github/index.html#dvcurator.github.search_existing">search_existing() (in module dvcurator.github)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="autoapi/dvcurator/github/index.html#dvcurator.github.search_existing">search_existing() (in module dvcurator.github)</a>
+</li>
       <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.MainApp.set_dropbox">set_dropbox() (dvcurator.gui.MainApp method)</a>
 </li>
       <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.MainApp.set_metadata">set_metadata() (dvcurator.gui.MainApp method)</a>
@@ -438,6 +459,14 @@ <h2 id="S">S</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="T">T</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="autoapi/dvcurator/gui/index.html#dvcurator.gui.TokenConfig">TokenConfig (class in dvcurator.gui)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="V">V</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>