Skip to content

Commit 2bd0304

Browse files
committed
add 2 more examples for Submission docstring
1 parent 1982ba6 commit 2bd0304

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

synapseclient/models/submission.py

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -312,6 +312,7 @@ class Submission(
312312
docker_digest: For Docker repositories, the digest of the submitted Docker image.
313313
314314
Example: Retrieve a Submission.
315+
 
315316
```python
316317
from synapseclient import Synapse
317318
from synapseclient.models import Submission
@@ -322,6 +323,50 @@ class Submission(
322323
submission = Submission(id="syn123456").get()
323324
print(submission)
324325
```
326+
327+
Example: Create and store a new Submission.
328+
 
329+
```python
330+
from synapseclient import Synapse
331+
from synapseclient.models import Submission
332+
333+
syn = Synapse()
334+
syn.login()
335+
336+
# Create a new submission
337+
submission = Submission(
338+
entity_id="syn123456",
339+
evaluation_id="9999999",
340+
name="My Submission"
341+
)
342+
343+
# Store the submission
344+
stored_submission = submission.store()
345+
print(f"Created submission with ID: {stored_submission.id}")
346+
```
347+
348+
Example: Get all submissions for a user.
349+
 
350+
```python
351+
from synapseclient import Synapse
352+
from synapseclient.models import Submission
353+
354+
syn = Synapse()
355+
syn.login()
356+
357+
# Get all submissions for a specific user in an evaluation
358+
submissions = list(Submission.get_user_submissions(
359+
evaluation_id="9999999",
360+
user_id="123456"
361+
))
362+
print(f"Found {len(submissions)} submissions for user")
363+
364+
# Get submissions for the current user (omit user_id)
365+
my_submissions = list(Submission.get_user_submissions(
366+
evaluation_id="9614543"
367+
))
368+
print(f"Found {len(my_submissions)} of my submissions")
369+
```
325370
"""
326371

327372
id: Optional[str] = None

0 commit comments

Comments
 (0)