Github API interface with csss-site-backend #48
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…t(), create github module
…d get_user_by_id, Added exception raising to add_user_to_org().
…d error code handling on add_user_to_org(), implemented delete_user_from_org()
…thonic throughout file
…er_from_team(). Removed erroneous alternative api endpoint in add_user_to_team(). Created remove_user_from_team().
|
Note that when generating organization invites, iirc we're restricted to 50/hr, so in some scenarios we may want to implement rate limiting on the secondary rate limit (which is described on the rate limit page above). We should be fine though as we're generating max 12 or so invites per term. We might also want to implement functions to list current members, which will be super easy and can probably be pushed to a new issue. |
EarthenSky
reviewed
Aug 5, 2024
EarthenSky
reviewed
Aug 5, 2024
EarthenSky
reviewed
Aug 5, 2024
Co-authored-by: Gabe <[email protected]>
EarthenSky
reviewed
Aug 5, 2024
EarthenSky
reviewed
Aug 5, 2024
EarthenSky
reviewed
Aug 5, 2024
EarthenSky
reviewed
Aug 5, 2024
EarthenSky
reviewed
Aug 5, 2024
EarthenSky
reviewed
Aug 5, 2024
…l in requests. Raises a ValueError when both uid and email are passed by design.
|
I'm testing this on a test organization |
EarthenSky
reviewed
Aug 5, 2024
EarthenSky
approved these changes
Aug 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #20. (Vibes)
The REST API provided by Github has constraints detailed here. Realistically the only constraint we care about is
x-ratelimit-remainingwhich I've already added a check for. We should probably further discuss how to gracefully handle this as currently I raise an exception when we hit <50 remaining API calls. As noted in #20, all of these functions are handled asynchronously, so I chose to leave a healthy margin to avoid being rate limited.I added the functionality requested, adding/removing from organizations, adding/removing from teams. This is implemented in a new
githubmodule.For testing I've created a new CSSS-Test-Organization, we can talk about transferring ownership of that in person/over call.
Authorization here in the
githubmodule is token based and administrated through the fine grained personal access token system in Github. As such we can just store it as an environment variableGITHUB_TOKEN.