Skip to content

[SYNPY-1508]: add tutorial for downloading files by Synapse ID concurrenty#1337

Merged
thomasyu888 merged 6 commits intodevelopfrom
SYNPY-1508-tutorial-loose-file
Apr 4, 2026
Merged

[SYNPY-1508]: add tutorial for downloading files by Synapse ID concurrenty#1337
thomasyu888 merged 6 commits intodevelopfrom
SYNPY-1508-tutorial-loose-file

Conversation

@thomasyu888
Copy link
Copy Markdown
Member

@thomasyu888 thomasyu888 commented Mar 13, 2026

Problem:

No tutorial for downloading one file or set of files

Solution:

Add tutorial

Testing:

https://synapsepythonclient--1337.org.readthedocs.build/en/1337/

…ntly

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@thomasyu888 thomasyu888 changed the title SYNPY-1508: add tutorial for downloading files by Synapse ID concurrenty [SYNPY-1508]: add tutorial for downloading files by Synapse ID concurrenty Mar 13, 2026
@thomasyu888 thomasyu888 marked this pull request as ready for review March 13, 2026 17:20
@thomasyu888 thomasyu888 requested a review from a team as a code owner March 13, 2026 17:20
Copy link
Copy Markdown
Contributor

@linglp linglp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I tested out the script, and it worked.

Copy link
Copy Markdown
Member

@BryanFauble BryanFauble left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. LGTM

Copilot AI review requested due to automatic review settings April 4, 2026 15:55
@thomasyu888 thomasyu888 enabled auto-merge (squash) April 4, 2026 15:55
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new Python tutorial page and accompanying script to demonstrate downloading a set of Synapse Files by Synapse ID concurrently, and wires the new tutorial into the docs navigation.

Changes:

  • Add a new tutorial page for downloading files by Synapse ID using the async API.
  • Add the corresponding tutorial script that concurrently downloads multiple files via File.get_async() + asyncio.gather.
  • Link the tutorial from mkdocs.yml nav and the Python tutorial index page.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
mkdocs.yml Adds the new tutorial page to the MkDocs navigation.
docs/tutorials/python/tutorial_scripts/download_data_by_synid.py New example script demonstrating concurrent downloads by Synapse ID.
docs/tutorials/python/download_data_by_synid.md New tutorial documentation page referencing the script snippets and full source.
docs/tutorials/python_client.md Adds a bullet linking to the new tutorial from the Python tutorials landing page.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@@ -0,0 +1,66 @@
[](){ #tutorial-downloading-a-file }
Copy link

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The page anchor id (tutorial-downloading-a-file) doesn’t match this tutorial’s topic/filename (downloading by Synapse ID). This looks like a copy/paste and makes reference-style links confusing/hard to add later. Please update the anchor to a unique, descriptive id (e.g., tutorial-downloading-data-by-synapse-id).

Suggested change
[](){ #tutorial-downloading-a-file }
[](){ #tutorial-downloading-data-by-synapse-id }

Copilot uses AI. Check for mistakes.
@@ -0,0 +1,43 @@
"""
Here is where you'll find the code for the downloading files by synapse ids tutorial.
Copy link

Copilot AI Apr 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docstring wording/capitalization is inconsistent with the rest of the docs ("Synapse IDs"); consider revising to use proper capitalization and clearer phrasing (e.g., "...downloading files by Synapse ID(s) tutorial").

Suggested change
Here is where you'll find the code for the downloading files by synapse ids tutorial.
Code for the downloading files by Synapse ID(s) tutorial.

Copilot uses AI. Check for mistakes.
@thomasyu888 thomasyu888 merged commit 693d01b into develop Apr 4, 2026
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants