Skip to content

Commit

Permalink
Run pre-commit
Browse files Browse the repository at this point in the history
  • Loading branch information
thomasyu888 committed Jun 3, 2023
1 parent 7a88c40 commit a129761
Show file tree
Hide file tree
Showing 59 changed files with 231 additions and 222 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* @Sage-Bionetworks/python-client-developers
* @Sage-Bionetworks/python-client-developers
6 changes: 3 additions & 3 deletions .github/workflows/codeql-analysis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,11 +48,11 @@ jobs:
# If you wish to specify custom queries, you can do so here or in a config file.
# By default, queries listed here will override any specified in a config file.
# Prefix the list here with "+" to use these queries and those in the config file.

# Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
# queries: security-extended,security-and-quality


# Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
# If this step fails, then you should remove it and run the build manually (see below)
- name: Autobuild
Expand All @@ -61,7 +61,7 @@ jobs:
# ℹ️ Command-line programs to run using the OS shell.
# 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun

# If the Autobuild fails above, remove it and uncomment the following three lines.
# If the Autobuild fails above, remove it and uncomment the following three lines.
# modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.

# - run: |
Expand Down
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,3 @@ docs/build/html/_sources/*
build/*

/venv

2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ pytest -vs tests/integration/synapseclient/test_command_line_client.py::test_tab
### Code style
The Synapse Python Client uses [`flake8`](https://pypi.org/project/flake8/) to enforce
The Synapse Python Client uses [`flake8`](https://pypi.org/project/flake8/) to enforce
[`PEP8`](https://legacy.python.org/dev/peps/pep-0008/) style consistency and to check for possible errors.
You can verify your code matches these expectations by running the **flake8** command from the project root directory:
Expand Down
1 change: 0 additions & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,3 @@ RUN pip3 install --upgrade pip
COPY . /synapsePythonClient
WORKDIR /synapsePythonClient
RUN python3 setup.py install

1 change: 0 additions & 1 deletion ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,4 +32,3 @@ A minimal reproducible example:
### Actual behavior

*What actually happened? Provide output or error messages from the console, if applicable.*

10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Branch | Build Status
develop | [![Build Status develop branch](https://github.com/Sage-Bionetworks/synapsePythonClient/workflows/build/badge.svg?branch=develop)](https://github.com/Sage-Bionetworks/synapsePythonClient/actions?query=branch%3Adevelop)
master | [![Build Status master branch](https://github.com/Sage-Bionetworks/synapsePythonClient/workflows/build/badge.svg?branch=master)](https://github.com/Sage-Bionetworks/synapsePythonClient/actions?query=branch%3Amaster)

[![Get the synapseclient from PyPI](https://img.shields.io/pypi/v/synapseclient.svg)](https://pypi.python.org/pypi/synapseclient/) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/synapseclient.svg)](https://pypi.python.org/pypi/synapseclient/)
[![Get the synapseclient from PyPI](https://img.shields.io/pypi/v/synapseclient.svg)](https://pypi.python.org/pypi/synapseclient/) [![Supported Python Versions](https://img.shields.io/pypi/pyversions/synapseclient.svg)](https://pypi.python.org/pypi/synapseclient/)

A Python client for [Sage Bionetworks'](https://www.sagebase.org) [Synapse](https://www.synapse.org/), a collaborative, open-source research platform that allows teams to share data, track analyses, and collaborate. The Python client can be used as a library for development of software that communicates with Synapse or as a command-line utility.

Expand All @@ -17,7 +17,7 @@ Documentation

For more information about the Python client, see:

* [Python client API docs](https://python-docs.synapse.org)
* [Python client API docs](https://python-docs.synapse.org)

For more information about interacting with Synapse, see:

Expand Down Expand Up @@ -154,10 +154,10 @@ The purpose of synapseutils is to create a space filled with convenience functio
import synapseutils
import synapseclient
syn = synapseclient.login()

#COPY: copies all Synapse entities to a destination location
synapseutils.copy(syn, "syn1234", destinationId = "syn2345")

#COPY WIKI: copies the wiki from the entity to a destination entity. Only a project can have sub wiki pages.
synapseutils.copyWiki(syn, "syn1234", destinationId = "syn2345")

Expand All @@ -169,7 +169,7 @@ The purpose of synapseutils is to create a space filled with convenience functio
print(dirpath)
print(dirname)
print(filename)


License and Copyright
---------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/Activity.rst
Original file line number Diff line number Diff line change
@@ -1 +1 @@
.. automodule:: synapseclient.activity
.. automodule:: synapseclient.activity
2 changes: 1 addition & 1 deletion docs/Annotations.rst
Original file line number Diff line number Diff line change
@@ -1 +1 @@
.. automodule:: synapseclient.annotations
.. automodule:: synapseclient.annotations
2 changes: 1 addition & 1 deletion docs/CNAME
Original file line number Diff line number Diff line change
@@ -1 +1 @@
python-docs.synapse.org
python-docs.synapse.org
2 changes: 1 addition & 1 deletion docs/Client.rst
Original file line number Diff line number Diff line change
@@ -1 +1 @@
.. automodule:: synapseclient.client
.. automodule:: synapseclient.client
1 change: 0 additions & 1 deletion docs/Credentials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -103,4 +103,3 @@ The second time you login, you will not have to enter any arguments to :code:`lo

import synapseclient
syn = synapseclient.login()

2 changes: 1 addition & 1 deletion docs/Evaluation.rst
Original file line number Diff line number Diff line change
@@ -1 +1 @@
.. automodule:: synapseclient.evaluation
.. automodule:: synapseclient.evaluation
1 change: 0 additions & 1 deletion docs/Team.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
.. automodule:: synapseclient.team
:members:

2 changes: 1 addition & 1 deletion docs/Views.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,4 @@ The change in annotations reflect in synGetAnnotations()::

syn.getAnnotations(file2['id'])

A View is a Table. Please visit `Tables <https://python-docs.synapse.org/build/html/Table.html#module-synapseclient.table>`_ to see how to change schema, update content, and other operations that can be done on View.
A View is a Table. Please visit `Tables <https://python-docs.synapse.org/build/html/Table.html#module-synapseclient.table>`_ to see how to change schema, update content, and other operations that can be done on View.
2 changes: 1 addition & 1 deletion docs/Wiki.rst
Original file line number Diff line number Diff line change
@@ -1 +1 @@
.. automodule:: synapseclient.wiki
.. automodule:: synapseclient.wiki
1 change: 0 additions & 1 deletion docs/_static/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,3 @@ div.header img {
table.field-list th {
word-break: normal;
}

12 changes: 6 additions & 6 deletions docs/build/html/Activity.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>Provenance &#8212; Synapse Python Client 2.7.2 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/custom.css" />

<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
Expand Down Expand Up @@ -46,15 +46,15 @@ <h3>Navigation</h3>
<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.7.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Provenance</a></li>
<li class="nav-item nav-item-this"><a href="">Provenance</a></li>
</ul>
</div>
</div>

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">

<span class="target" id="module-synapseclient.activity"></span><div class="section" id="provenance">
<h1>Provenance<a class="headerlink" href="#provenance" title="Permalink to this headline"></a></h1>
<p>The Activity object represents the source of a data set or the data processing steps used to produce it. Using
Expand Down Expand Up @@ -247,7 +247,7 @@ <h3>Navigation</h3>
<a href="Evaluation.html" title="Evaluations"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.7.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Provenance</a></li>
<li class="nav-item nav-item-this"><a href="">Provenance</a></li>
</ul>
</div>
<div class="footer">
Expand All @@ -264,4 +264,4 @@ <h3>Navigation</h3>
ga('send', 'pageview');
</script>
</body>
</html>
</html>
12 changes: 6 additions & 6 deletions docs/build/html/Annotations.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>Annotations &#8212; Synapse Python Client 2.7.2 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/custom.css" />

<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
Expand Down Expand Up @@ -46,15 +46,15 @@ <h3>Navigation</h3>
<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.7.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Annotations</a></li>
<li class="nav-item nav-item-this"><a href="">Annotations</a></li>
</ul>
</div>
</div>

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">

<span class="target" id="module-synapseclient.annotations"></span><div class="section" id="annotations">
<h1>Annotations<a class="headerlink" href="#annotations" title="Permalink to this headline"></a></h1>
<p>Annotations are arbitrary metadata attached to Synapse entities. They can be accessed like ordinary object properties
Expand Down Expand Up @@ -203,7 +203,7 @@ <h3>Navigation</h3>
<a href="Activity.html" title="Provenance"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.7.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Annotations</a></li>
<li class="nav-item nav-item-this"><a href="">Annotations</a></li>
</ul>
</div>
<div class="footer">
Expand All @@ -220,4 +220,4 @@ <h3>Navigation</h3>
ga('send', 'pageview');
</script>
</body>
</html>
</html>
12 changes: 6 additions & 6 deletions docs/build/html/Client.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>Synapse Client &#8212; Synapse Python Client 2.7.2 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/custom.css" />

<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
Expand Down Expand Up @@ -46,15 +46,15 @@ <h3>Navigation</h3>
<a href="reticulate.html" title="Using synapseclient with R through reticulate"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.7.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Synapse Client</a></li>
<li class="nav-item nav-item-this"><a href="">Synapse Client</a></li>
</ul>
</div>
</div>

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">

<span class="target" id="module-synapseclient.client"></span><div class="section" id="synapse-client">
<h1>Synapse Client<a class="headerlink" href="#synapse-client" title="Permalink to this headline"></a></h1>
<p>The <cite>Synapse</cite> object encapsulates a connection to the Synapse service and is used for building projects, uploading and
Expand Down Expand Up @@ -1631,7 +1631,7 @@ <h3>Navigation</h3>
<a href="reticulate.html" title="Using synapseclient with R through reticulate"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.7.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Synapse Client</a></li>
<li class="nav-item nav-item-this"><a href="">Synapse Client</a></li>
</ul>
</div>
<div class="footer">
Expand All @@ -1648,4 +1648,4 @@ <h3>Navigation</h3>
ga('send', 'pageview');
</script>
</body>
</html>
</html>
12 changes: 6 additions & 6 deletions docs/build/html/CommandLineClient.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>Synapse command line client &#8212; Synapse Python Client 2.7.2 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/custom.css" />

<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
Expand Down Expand Up @@ -46,15 +46,15 @@ <h3>Navigation</h3>
<a href="Versions.html" title="Version Functions"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.7.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Synapse command line client</a></li>
<li class="nav-item nav-item-this"><a href="">Synapse command line client</a></li>
</ul>
</div>
</div>

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">

<div class="section" id="synapse-command-line-client">
<h1>Synapse command line client<a class="headerlink" href="#synapse-command-line-client" title="Permalink to this headline"></a></h1>
<p>The Synapse Python Client can be used from the command line via the <strong>synapse</strong> command.</p>
Expand Down Expand Up @@ -1115,7 +1115,7 @@ <h3>Navigation</h3>
<a href="Versions.html" title="Version Functions"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.7.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Synapse command line client</a></li>
<li class="nav-item nav-item-this"><a href="">Synapse command line client</a></li>
</ul>
</div>
<div class="footer">
Expand All @@ -1132,4 +1132,4 @@ <h3>Navigation</h3>
ga('send', 'pageview');
</script>
</body>
</html>
</html>
12 changes: 6 additions & 6 deletions docs/build/html/Credentials.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
<title>Manage Synapse Credentials &#8212; Synapse Python Client 2.7.2 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/custom.css" />

<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
Expand Down Expand Up @@ -46,15 +46,15 @@ <h3>Navigation</h3>
<a href="index.html" title="Synapse Python Client Documentation"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.7.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Manage Synapse Credentials</a></li>
<li class="nav-item nav-item-this"><a href="">Manage Synapse Credentials</a></li>
</ul>
</div>
</div>

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">

<div class="section" id="manage-synapse-credentials">
<h1>Manage Synapse Credentials<a class="headerlink" href="#manage-synapse-credentials" title="Permalink to this headline"></a></h1>
<p>There are multiple ways one can login to Synapse. We recommend users to choose the method that fits their workflow.</p>
Expand Down Expand Up @@ -208,7 +208,7 @@ <h3>Navigation</h3>
<a href="index.html" title="Synapse Python Client Documentation"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.7.2 documentation</a> &#187;</li>
<li class="nav-item nav-item-this"><a href="">Manage Synapse Credentials</a></li>
<li class="nav-item nav-item-this"><a href="">Manage Synapse Credentials</a></li>
</ul>
</div>
<div class="footer">
Expand All @@ -225,4 +225,4 @@ <h3>Navigation</h3>
ga('send', 'pageview');
</script>
</body>
</html>
</html>
Loading

0 comments on commit a129761

Please sign in to comment.