Skip to content

Commit 2c096bb

Browse files
thomasyu888thomasyu888
committed
Update documentation
1 parent 55bf41c commit 2c096bb

36 files changed

+829
-254
lines changed

‎docs/Multipart_upload.rst‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
.. automodule:: synapseclient.multipart_upload
1+
.. automodule:: synapseclient.core.upload.multipart_upload
22
:members:
33

4-
.. autofunction:: synapseclient.multipart_upload._multipart_upload
5-
6-
.. autofunction:: synapseclient.multipart_upload._start_multipart_upload
4+
.. autofunction:: synapseclient.core.upload.multipart_upload._multipart_upload

‎docs/Utilities.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
.. automodule:: synapseclient.utils
1+
.. automodule:: synapseclient.core.utils
22
:members:

‎docs/build/html/.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 0ab4d0864a9a535e9036f215aedd1e79
3+
config: be2de010353066a9eb43fc2000487114
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/build/html/Activity.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta charset="utf-8" />
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Provenance &#8212; Synapse Python Client 2.5.1 documentation</title>
9+
<title>Provenance &#8212; Synapse Python Client 2.6.0 documentation</title>
1010
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
1212

@@ -45,7 +45,7 @@ <h3>Navigation</h3>
4545
<li class="right" >
4646
<a href="Evaluation.html" title="Evaluations"
4747
accesskey="P">previous</a> |</li>
48-
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.5.1 documentation</a> &#187;</li>
48+
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.6.0 documentation</a> &#187;</li>
4949
<li class="nav-item nav-item-this"><a href="">Provenance</a></li>
5050
</ul>
5151
</div>
@@ -242,13 +242,13 @@ <h3>Navigation</h3>
242242
<li class="right" >
243243
<a href="Evaluation.html" title="Evaluations"
244244
>previous</a> |</li>
245-
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.5.1 documentation</a> &#187;</li>
245+
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.6.0 documentation</a> &#187;</li>
246246
<li class="nav-item nav-item-this"><a href="">Provenance</a></li>
247247
</ul>
248248
</div>
249249
<div class="footer">
250250
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
251-
Last updated on Apr 07, 2022.
251+
Last updated on Apr 15, 2022.
252252
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.
253253
</div>
254254
<script type="text/javascript">

‎docs/build/html/Annotations.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta charset="utf-8" />
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Annotations &#8212; Synapse Python Client 2.5.1 documentation</title>
9+
<title>Annotations &#8212; Synapse Python Client 2.6.0 documentation</title>
1010
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
1212

@@ -45,7 +45,7 @@ <h3>Navigation</h3>
4545
<li class="right" >
4646
<a href="Activity.html" title="Provenance"
4747
accesskey="P">previous</a> |</li>
48-
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.5.1 documentation</a> &#187;</li>
48+
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.6.0 documentation</a> &#187;</li>
4949
<li class="nav-item nav-item-this"><a href="">Annotations</a></li>
5050
</ul>
5151
</div>
@@ -196,13 +196,13 @@ <h3>Navigation</h3>
196196
<li class="right" >
197197
<a href="Activity.html" title="Provenance"
198198
>previous</a> |</li>
199-
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.5.1 documentation</a> &#187;</li>
199+
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.6.0 documentation</a> &#187;</li>
200200
<li class="nav-item nav-item-this"><a href="">Annotations</a></li>
201201
</ul>
202202
</div>
203203
<div class="footer">
204204
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
205-
Last updated on Apr 07, 2022.
205+
Last updated on Apr 15, 2022.
206206
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.
207207
</div>
208208
<script type="text/javascript">

‎docs/build/html/Client.html‎

Lines changed: 5 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta charset="utf-8" />
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Synapse Client &#8212; Synapse Python Client 2.5.1 documentation</title>
9+
<title>Synapse Client &#8212; Synapse Python Client 2.6.0 documentation</title>
1010
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
1212

@@ -45,7 +45,7 @@ <h3>Navigation</h3>
4545
<li class="right" >
4646
<a href="reticulate.html" title="Using synapseclient with R through reticulate"
4747
accesskey="P">previous</a> |</li>
48-
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.5.1 documentation</a> &#187;</li>
48+
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.6.0 documentation</a> &#187;</li>
4949
<li class="nav-item nav-item-this"><a href="">Synapse Client</a></li>
5050
</ul>
5151
</div>
@@ -109,12 +109,6 @@ <h2>Synapse<a class="headerlink" href="#synapse" title="Permalink to this headli
109109
<li><p><a class="reference internal" href="index.html#synapseclient.Synapse.login" title="synapseclient.Synapse.login"><code class="xref py py-func docutils literal notranslate"><span class="pre">synapseclient.Synapse.login()</span></code></a></p></li>
110110
<li><p><a class="reference internal" href="index.html#synapseclient.Synapse.setEndpoints" title="synapseclient.Synapse.setEndpoints"><code class="xref py py-func docutils literal notranslate"><span class="pre">synapseclient.Synapse.setEndpoints()</span></code></a></p></li>
111111
</ul>
112-
<dl class="py method">
113-
<dt id="synapseclient.Synapse.clear_download_list">
114-
<code class="sig-name descname"><span class="pre">clear_download_list</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#synapseclient.Synapse.clear_download_list" title="Permalink to this definition"></a></dt>
115-
<dd><p>Clear all files from download list</p>
116-
</dd></dl>
117-
118112
<dl class="py method">
119113
<dt id="synapseclient.Synapse.createColumns">
120114
<code class="sig-name descname"><span class="pre">createColumns</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">columns</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#synapseclient.Synapse.createColumns" title="Permalink to this definition"></a></dt>
@@ -387,7 +381,7 @@ <h2>Synapse<a class="headerlink" href="#synapse" title="Permalink to this headli
387381
</dl>
388382
<p>Also see:</p>
389383
<ul class="simple">
390-
<li><p><a class="reference internal" href="synapseutils.html#module-synapseutils.walk" title="synapseutils.walk"><code class="xref py py-func docutils literal notranslate"><span class="pre">synapseutils.walk()</span></code></a></p></li>
384+
<li><p><code class="xref py py-func docutils literal notranslate"><span class="pre">synapseutils.walk()</span></code></p></li>
391385
</ul>
392386
</dd></dl>
393387

@@ -791,34 +785,6 @@ <h2>Synapse<a class="headerlink" href="#synapse" title="Permalink to this headli
791785
</dl>
792786
</dd></dl>
793787

794-
<dl class="py method">
795-
<dt id="synapseclient.Synapse.get_download_list">
796-
<code class="sig-name descname"><span class="pre">get_download_list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">manifest</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">downloadLocation</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> &#x2192; <span class="pre">str</span><a class="headerlink" href="#synapseclient.Synapse.get_download_list" title="Permalink to this definition"></a></dt>
797-
<dd><p>Download all files from your Synapse download list</p>
798-
<dl class="field-list simple">
799-
<dt class="field-odd">Parameters</dt>
800-
<dd class="field-odd"><ul class="simple">
801-
<li><p><strong>manifest</strong> – Whether to keep the manifest file for the download list. Defaults to True.</p></li>
802-
<li><p><strong>downloadLocation</strong> – Directory to download files to.</p></li>
803-
</ul>
804-
</dd>
805-
<dt class="field-even">Returns</dt>
806-
<dd class="field-even"><p>manifest file with file paths</p>
807-
</dd>
808-
</dl>
809-
</dd></dl>
810-
811-
<dl class="py method">
812-
<dt id="synapseclient.Synapse.get_download_list_manifest">
813-
<code class="sig-name descname"><span class="pre">get_download_list_manifest</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#synapseclient.Synapse.get_download_list_manifest" title="Permalink to this definition"></a></dt>
814-
<dd><p>Get the path of the download list manifest file</p>
815-
<dl class="field-list simple">
816-
<dt class="field-odd">Returns</dt>
817-
<dd class="field-odd"><p>path of download list manifest file</p>
818-
</dd>
819-
</dl>
820-
</dd></dl>
821-
822788
<dl class="py method">
823789
<dt id="synapseclient.Synapse.get_membership_status">
824790
<code class="sig-name descname"><span class="pre">get_membership_status</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">userid</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">team</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#synapseclient.Synapse.get_membership_status" title="Permalink to this definition"></a></dt>
@@ -1074,21 +1040,6 @@ <h2>Synapse<a class="headerlink" href="#synapse" title="Permalink to this headli
10741040
</dl>
10751041
</dd></dl>
10761042

1077-
<dl class="py method">
1078-
<dt id="synapseclient.Synapse.remove_from_download_list">
1079-
<code class="sig-name descname"><span class="pre">remove_from_download_list</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">list_of_files</span></span><span class="p"><span class="pre">:</span></span> <span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Dict</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> &#x2192; <span class="pre">int</span><a class="headerlink" href="#synapseclient.Synapse.remove_from_download_list" title="Permalink to this definition"></a></dt>
1080-
<dd><p>Remove a batch of files from download list</p>
1081-
<dl class="field-list simple">
1082-
<dt class="field-odd">Param</dt>
1083-
<dd class="field-odd"><p>array of files in the format of a mapping
1084-
{fileEntityId: synid, versionNumber: version}</p>
1085-
</dd>
1086-
<dt class="field-even">Returns</dt>
1087-
<dd class="field-even"><p>Number of files removed from download list</p>
1088-
</dd>
1089-
</dl>
1090-
</dd></dl>
1091-
10921043
<dl class="py method">
10931044
<dt id="synapseclient.Synapse.restDELETE">
10941045
<code class="sig-name descname"><span class="pre">restDELETE</span></code><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">uri</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">endpoint</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">headers</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">retryPolicy</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">{}</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">requests_session</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</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="#synapseclient.Synapse.restDELETE" title="Permalink to this definition"></a></dt>
@@ -1617,13 +1568,13 @@ <h3>Navigation</h3>
16171568
<li class="right" >
16181569
<a href="reticulate.html" title="Using synapseclient with R through reticulate"
16191570
>previous</a> |</li>
1620-
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.5.1 documentation</a> &#187;</li>
1571+
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.6.0 documentation</a> &#187;</li>
16211572
<li class="nav-item nav-item-this"><a href="">Synapse Client</a></li>
16221573
</ul>
16231574
</div>
16241575
<div class="footer">
16251576
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
1626-
Last updated on Apr 07, 2022.
1577+
Last updated on Apr 15, 2022.
16271578
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.
16281579
</div>
16291580
<script type="text/javascript">

‎docs/build/html/CommandLineClient.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta charset="utf-8" />
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Synapse command line client &#8212; Synapse Python Client 2.5.1 documentation</title>
9+
<title>Synapse command line client &#8212; Synapse Python Client 2.6.0 documentation</title>
1010
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
1212

@@ -45,7 +45,7 @@ <h3>Navigation</h3>
4545
<li class="right" >
4646
<a href="Versions.html" title="&lt;no title&gt;"
4747
accesskey="P">previous</a> |</li>
48-
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.5.1 documentation</a> &#187;</li>
48+
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.6.0 documentation</a> &#187;</li>
4949
<li class="nav-item nav-item-this"><a href="">Synapse command line client</a></li>
5050
</ul>
5151
</div>
@@ -1106,13 +1106,13 @@ <h3>Navigation</h3>
11061106
<li class="right" >
11071107
<a href="Versions.html" title="&lt;no title&gt;"
11081108
>previous</a> |</li>
1109-
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.5.1 documentation</a> &#187;</li>
1109+
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.6.0 documentation</a> &#187;</li>
11101110
<li class="nav-item nav-item-this"><a href="">Synapse command line client</a></li>
11111111
</ul>
11121112
</div>
11131113
<div class="footer">
11141114
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
1115-
Last updated on Apr 07, 2022.
1115+
Last updated on Apr 15, 2022.
11161116
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.
11171117
</div>
11181118
<script type="text/javascript">

‎docs/build/html/Credentials.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta charset="utf-8" />
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Manage Synapse Credentials &#8212; Synapse Python Client 2.5.1 documentation</title>
9+
<title>Manage Synapse Credentials &#8212; Synapse Python Client 2.6.0 documentation</title>
1010
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
1212

@@ -45,7 +45,7 @@ <h3>Navigation</h3>
4545
<li class="right" >
4646
<a href="index.html" title="Synapse Python Client Documentation"
4747
accesskey="P">previous</a> |</li>
48-
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.5.1 documentation</a> &#187;</li>
48+
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.6.0 documentation</a> &#187;</li>
4949
<li class="nav-item nav-item-this"><a href="">Manage Synapse Credentials</a></li>
5050
</ul>
5151
</div>
@@ -201,13 +201,13 @@ <h3>Navigation</h3>
201201
<li class="right" >
202202
<a href="index.html" title="Synapse Python Client Documentation"
203203
>previous</a> |</li>
204-
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.5.1 documentation</a> &#187;</li>
204+
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.6.0 documentation</a> &#187;</li>
205205
<li class="nav-item nav-item-this"><a href="">Manage Synapse Credentials</a></li>
206206
</ul>
207207
</div>
208208
<div class="footer">
209209
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
210-
Last updated on Apr 07, 2022.
210+
Last updated on Apr 15, 2022.
211211
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.
212212
</div>
213213
<script type="text/javascript">

‎docs/build/html/Entity.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta charset="utf-8" />
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Entity &#8212; Synapse Python Client 2.5.1 documentation</title>
9+
<title>Entity &#8212; Synapse Python Client 2.6.0 documentation</title>
1010
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
1212

@@ -45,7 +45,7 @@ <h3>Navigation</h3>
4545
<li class="right" >
4646
<a href="Client.html" title="Synapse Client"
4747
accesskey="P">previous</a> |</li>
48-
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.5.1 documentation</a> &#187;</li>
48+
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.6.0 documentation</a> &#187;</li>
4949
<li class="nav-item nav-item-this"><a href="">Entity</a></li>
5050
</ul>
5151
</div>
@@ -448,13 +448,13 @@ <h3>Navigation</h3>
448448
<li class="right" >
449449
<a href="Client.html" title="Synapse Client"
450450
>previous</a> |</li>
451-
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.5.1 documentation</a> &#187;</li>
451+
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.6.0 documentation</a> &#187;</li>
452452
<li class="nav-item nav-item-this"><a href="">Entity</a></li>
453453
</ul>
454454
</div>
455455
<div class="footer">
456456
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
457-
Last updated on Apr 07, 2022.
457+
Last updated on Apr 15, 2022.
458458
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.
459459
</div>
460460
<script type="text/javascript">

‎docs/build/html/Evaluation.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta charset="utf-8" />
88
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
9-
<title>Evaluations &#8212; Synapse Python Client 2.5.1 documentation</title>
9+
<title>Evaluations &#8212; Synapse Python Client 2.6.0 documentation</title>
1010
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
1212

@@ -45,7 +45,7 @@ <h3>Navigation</h3>
4545
<li class="right" >
4646
<a href="Entity.html" title="Entity"
4747
accesskey="P">previous</a> |</li>
48-
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.5.1 documentation</a> &#187;</li>
48+
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.6.0 documentation</a> &#187;</li>
4949
<li class="nav-item nav-item-this"><a href="">Evaluations</a></li>
5050
</ul>
5151
</div>
@@ -273,13 +273,13 @@ <h3>Navigation</h3>
273273
<li class="right" >
274274
<a href="Entity.html" title="Entity"
275275
>previous</a> |</li>
276-
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.5.1 documentation</a> &#187;</li>
276+
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.6.0 documentation</a> &#187;</li>
277277
<li class="nav-item nav-item-this"><a href="">Evaluations</a></li>
278278
</ul>
279279
</div>
280280
<div class="footer">
281281
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
282-
Last updated on Apr 07, 2022.
282+
Last updated on Apr 15, 2022.
283283
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.
284284
</div>
285285
<script type="text/javascript">

0 commit comments

Comments
 (0)