Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update streaming.py #1780

Merged
merged 4 commits into from
Feb 7, 2024
Merged

Update streaming.py #1780

merged 4 commits into from
Feb 7, 2024

Conversation

oruebel
Copy link
Contributor

@oruebel oruebel commented Oct 7, 2023

Motivation

Make it easier for users to find more information about the DANDI API from the streaming tutorial.

Checklist

  • Did you update CHANGELOG.md with your changes?
  • Have you checked our Contributing document?
  • Have you ensured the PR clearly describes the problem and the solution?
  • Is your contribution compliant with our coding style? This can be checked running flake8 from the source directory.
  • Have you checked to ensure that there aren't other open Pull Requests for the same change?
  • Have you included the relevant issue number using "Fix #XXX" notation where XXX is the issue number? By including "Fix #XXX" you allow GitHub to close issue #XXX when the PR is merged.

@oruebel
Copy link
Contributor Author

oruebel commented Oct 7, 2023

@bendichter is there maybe a tutorial about the DANDI Python API that we could point to. We can point to the API docs https://dandi.readthedocs.io/en/stable/modref/index.html but I was just wondering whether there is a more accessible tutorial available as well?

@codecov
Copy link

codecov bot commented Oct 7, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5d0e98d) 91.99% compared to head (dcfd696) 84.59%.

Additional details and impacted files
@@            Coverage Diff             @@
##              dev    #1780      +/-   ##
==========================================
- Coverage   91.99%   84.59%   -7.40%     
==========================================
  Files          27       27              
  Lines        2623     2623              
  Branches      685      685              
==========================================
- Hits         2413     2219     -194     
- Misses        138      315     +177     
- Partials       72       89      +17     
Flag Coverage Δ
integration ?
unit 84.59% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mavaylon1
Copy link
Collaborator

@oruebel I added a streaming section to #1781 to stream an entire Dandiset for HERD to help with the lack of documentation on this use case of streaming.

rly
rly previously approved these changes Feb 7, 2024
@rly
Copy link
Contributor

rly commented Feb 7, 2024

@oruebel want to merge this?

@oruebel oruebel marked this pull request as ready for review February 7, 2024 18:30
@oruebel oruebel enabled auto-merge (squash) February 7, 2024 18:31
@oruebel oruebel merged commit 3597052 into dev Feb 7, 2024
19 of 23 checks passed
@oruebel oruebel deleted the docs/ref_dandi_api branch February 7, 2024 18:54
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.

3 participants