Merge pull request #820 from jkiang13/py-230-release-notes

py-2.3.0 release notes
Sage-Bionetworks · Mar 3, 2021 · 6f5f545 · 6f5f545
2 parents b8ae382 + ae618fa
commit 6f5f545
Show file tree

Hide file tree

Showing 30 changed files with 1,025 additions and 386 deletions.
diff --git a/docs/Credentials.rst b/docs/Credentials.rst
@@ -11,10 +11,15 @@ Use `username` and `password` to login as follows::
     import synapseclient
     syn = synapseclient.login("username", "password")
 
+Alternately you can login using a personal access token obtained from synapse.org under your Settings. Note that a token must minimally have the *view* scope to be used with the Synapse Python Client.
+
+::
+
+    syn = synapseclient.login(authToken="authtoken")
 
 Use `.synapseConfig`
 ====================
-For writing code using the Synapse Python client, that is easy to share with others, please do not include your credentials in the code. Instead, please use `.synapseConfig` file to manage your credentials.
+For writing code using the Synapse Python client that is easy to share with others, please do not include your credentials in the code. Instead, please use `.synapseConfig` file to manage your credentials.
 
 When installing the Synapse Python client, the `.synapseConfig` is added to your home directory. Open the `.synapseConfig` file and find the following section::
 
@@ -23,8 +28,7 @@ When installing the Synapse Python client, the `.synapseConfig` is added to your
     #password = <password>
     #authtoken = <authtoken>
 
-To enable this section, uncomment it. You will only need to specify either a `username` and `password` pair, or an `authtoken`. For security purposes, we recommend that you use `authtoken` instead of your `password`.
-You can generate a personal access token to that can be used in the .synapseConfig as an authtoken at synapse.org under your Settings. A token must minimally have the *view* scope to be used with the Synapse Python Client.
+To enable this section, uncomment it. You will only need to specify either a `username` and `password` pair, or an `authtoken`. For security purposes, we recommend that you use `authtoken` instead of your `password`. A personal access token generated from your synapse.org Settings can be used as your *.synapseConfig* authtoken.
 
 ::
 

diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 934cc1dc9fa9888318946e50a8c1f2e7
+config: 28b32c8cad55c715a9d6bb541b4c4ce5
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/Activity.html b/docs/build/html/Activity.html
@@ -6,7 +6,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Provenance &#8212; Synapse Python Client 2.2.2 documentation</title>
+    <title>Provenance &#8212; Synapse Python Client 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/custom.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
@@ -46,7 +46,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="Evaluation.html" title="Evaluations"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.2.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.3.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Provenance</a></li> 
       </ul>
     </div>  
@@ -243,13 +243,13 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="Evaluation.html" title="Evaluations"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.2.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.3.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Provenance</a></li> 
       </ul>
     </div>
     <div class="footer">
     &copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
-      Last updated on Oct 09, 2020.
+      Last updated on Feb 24, 2021.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.
     </div>
     <script type="text/javascript">

diff --git a/docs/build/html/Annotations.html b/docs/build/html/Annotations.html
@@ -6,7 +6,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Annotations &#8212; Synapse Python Client 2.2.2 documentation</title>
+    <title>Annotations &#8212; Synapse Python Client 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/custom.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
@@ -46,7 +46,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="Activity.html" title="Provenance"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.2.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.3.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Annotations</a></li> 
       </ul>
     </div>  
@@ -197,13 +197,13 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="Activity.html" title="Provenance"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.2.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.3.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Annotations</a></li> 
       </ul>
     </div>
     <div class="footer">
     &copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
-      Last updated on Oct 09, 2020.
+      Last updated on Feb 24, 2021.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.
     </div>
     <script type="text/javascript">

diff --git a/docs/build/html/Client.html b/docs/build/html/Client.html
@@ -6,7 +6,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Synapse Client &#8212; Synapse Python Client 2.2.2 documentation</title>
+    <title>Synapse Client &#8212; Synapse Python Client 2.3.0 documentation</title>
     <link rel="stylesheet" href="_static/custom.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
@@ -46,7 +46,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="S3Storage.html" title="S3 Storage Features"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.2.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.3.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Synapse Client</a></li> 
       </ul>
     </div>  
@@ -79,7 +79,7 @@ <h2>Login<a class="headerlink" href="#login" title="Permalink to this headline">
 <h2>Synapse<a class="headerlink" href="#synapse" title="Permalink to this headline">¶</a></h2>
 <dl class="py class">
 <dt id="synapseclient.Synapse">
-<em class="property">class </em><code class="sig-prename descclassname">synapseclient.</code><code class="sig-name descname">Synapse</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">repoEndpoint</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">authEndpoint</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">fileHandleEndpoint</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">portalEndpoint</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">debug</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">skip_checks</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">configPath</span><span class="o">=</span><span class="default_value">'/Users/jkiang/.synapseConfig'</span></em>, <em class="sig-param"><span class="n">requests_session</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#synapseclient.Synapse" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="sig-prename descclassname">synapseclient.</code><code class="sig-name descname">Synapse</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">repoEndpoint</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">authEndpoint</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">fileHandleEndpoint</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">portalEndpoint</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">debug</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">skip_checks</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">configPath</span><span class="o">=</span><span class="default_value">'/Users/jkiang/.synapseConfig'</span></em>, <em class="sig-param"><span class="n">requests_session</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">cache_root_dir</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#synapseclient.Synapse" title="Permalink to this definition">¶</a></dt>
 <dd><p>Constructs a Python client object for the Synapse repository service</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
@@ -203,6 +203,9 @@ <h2>Synapse<a class="headerlink" href="#synapse" title="Permalink to this headli
 <li><p><strong>sts_enabled</strong> – Whether this storage location should be STS enabled</p></li>
 </ul>
 </dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>a 3-tuple of the synapse Folder, a the storage location setting, and the project setting dictionaries</p>
+</dd>
 </dl>
 </dd></dl>
 
@@ -872,13 +875,28 @@ <h2>Synapse<a class="headerlink" href="#synapse" title="Permalink to this headli
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt id="synapseclient.Synapse.is_certified">
+<code class="sig-name descname">is_certified</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">user</span><span class="p">:</span> <span class="n">Union<span class="p">[</span>str<span class="p">, </span>int<span class="p">]</span></span></em><span class="sig-paren">)</span> &#x2192; bool<a class="headerlink" href="#synapseclient.Synapse.is_certified" title="Permalink to this definition">¶</a></dt>
+<dd><p>Determines whether a Synapse user is a certified user.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Params user</dt>
+<dd class="field-odd"><p>Synapse username or Id</p>
+</dd>
+<dt class="field-even">Returns</dt>
+<dd class="field-even"><p>True if the Synapse user is certified</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py method">
 <dt id="synapseclient.Synapse.login">
-<code class="sig-name descname">login</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">email</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">password</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">apiKey</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sessionToken</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">rememberMe</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">silent</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">forced</span><span class="o">=</span><span class="default_value">False</span></em><span class="sig-paren">)</span><a class="headerlink" href="#synapseclient.Synapse.login" title="Permalink to this definition">¶</a></dt>
+<code class="sig-name descname">login</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">email</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">password</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">apiKey</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">sessionToken</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="n">rememberMe</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">silent</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">forced</span><span class="o">=</span><span class="default_value">False</span></em>, <em class="sig-param"><span class="n">authToken</span><span class="o">=</span><span class="default_value">None</span></em><span class="sig-paren">)</span><a class="headerlink" href="#synapseclient.Synapse.login" title="Permalink to this definition">¶</a></dt>
 <dd><p>Valid combinations of login() arguments:</p>
 <ul class="simple">
 <li><p>email/username and password</p></li>
 <li><p>email/username and apiKey (Base64 encoded string)</p></li>
+<li><p>authToken</p></li>
 <li><p>sessionToken (<strong>DEPRECATED</strong>)</p></li>
 </ul>
 <dl class="simple">
@@ -899,6 +917,10 @@ <h2>Synapse<a class="headerlink" href="#synapse" title="Permalink to this headli
 following fields: email, password, apiKey</p></li>
 <li><p><strong>rememberMe</strong> – Whether the authentication information should be cached in your operating system’s
 credential storage.</p></li>
+<li><p><strong>silent</strong> – Suppress login welcome message</p></li>
+<li><p><strong>forced</strong> – Skip any cached credential lookup</p></li>
+<li><p><strong>authToken</strong> – A bearer authorization token, e.g. a personal access token, can be used in lieu of a
+password or apiKey</p></li>
 </ul>
 </dd>
 </dl>
@@ -1548,13 +1570,13 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="S3Storage.html" title="S3 Storage Features"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.2.2 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.3.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Synapse Client</a></li> 
       </ul>
     </div>
     <div class="footer">
     &copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
-      Last updated on Oct 17, 2020.
+      Last updated on Feb 24, 2021.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.
     </div>
     <script type="text/javascript">