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

Add a TimersClient app scope helper for data_access + example doc #1074

Merged
merged 4 commits into from
Oct 25, 2024

Conversation

sirosen
Copy link
Member

@sirosen sirosen commented Oct 4, 2024

  1. Implement add_app_transfer_data_access_scope
  2. Add a new GlobusApp example using TimersClient in 'experimental' docs
  3. Promote the "experimental" timer example doc to main example docs

📚 Documentation preview 📚: https://globus-sdk-python--1074.org.readthedocs.build/en/1074/

This is a Timers helper for setting up a data_access scope in the
correct nested context.
It has identical validation to the Transfer equivalent, and is tested
for parity.
This is a new (experimental) example, meant to replace the
"timer_operations" examples with a more refined usage, based on
GlobusApp. It relies on
`TimersClient.add_app_transfer_data_access_scope`.
@sirosen sirosen force-pushed the timers-client-scope-helper branch from c1d06bf to ae6a24f Compare October 22, 2024 16:16
@sirosen sirosen requested a review from m1yag1 as a code owner October 22, 2024 16:16
This moves the doc into non-experimental examples, and replaces the
older 'timer_operations' example it was written to replace.
@sirosen
Copy link
Member Author

sirosen commented Oct 22, 2024

After rebasing and asking for a fresh review, I noticed that the doc is in the wrong place because this PR was filed several weeks ago (before GlobusApp moved out of experimental). I've therefore pushed an additional change to move these docs to their intended home, replacing the "Timer Operations" examples.

Copy link
Contributor

@ada-globus ada-globus left a comment

Choose a reason for hiding this comment

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

Still reading, but dropping notes on the examples in the meantime

Co-authored-by: Ada <107940310+ada-globus@users.noreply.github.com>
@sirosen sirosen force-pushed the timers-client-scope-helper branch from 65ace65 to 7b1321f Compare October 24, 2024 14:27
@sirosen
Copy link
Member Author

sirosen commented Oct 24, 2024

I applied the suggestion + amended to add other suggested fixes.

Copy link
Contributor

@ada-globus ada-globus left a comment

Choose a reason for hiding this comment

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

Looks good!

@sirosen sirosen merged commit 8f33a74 into globus:main Oct 25, 2024
16 checks passed
@sirosen sirosen deleted the timers-client-scope-helper branch October 25, 2024 19:29
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.

2 participants