Draft
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This pull request introduces significant improvements and new features to the Gundi async Python client, focusing on enhanced authentication flexibility, improved error handling, and better documentation. The update also modernizes the packaging configuration and maintains backward compatibility for existing users.
Key highlights:
OAUTH_*) and legacy (KEYCLOAK_*) names.pyproject.toml), with dynamic versioning.Authentication Improvements
KEYCLOAK_*variables and arguments is preserved. (gundi_client_v2/auth.py[1]gundi_client_v2/client.py[2] [3]gundi_client_v2/settings.py[4]OAUTH_*names, with fallbacks toKEYCLOAK_*for seamless migration. (gundi_client_v2/settings.py[1]gundi_client_v2/client.py[2]Error Handling and Exceptions
GundiClientError,AuthenticationError, andGundiAPIErrorfor more granular error handling and clearer failure modes. (gundi_client_v2/errors.py[1]gundi_client_v2/__init__.py[2]gundi_client_v2/client.py[1] [2] [3] [4]Documentation and Usage Examples
README.mdwith improved introduction, quick start, end-to-end examples, configuration, authentication modes, error handling, and usage for bothGundiClientandGundiDataSenderClient. (README.mdREADME.mdL1-R245)Packaging and Versioning
pyproject.tomlusing Hatchling, with dynamic versioning sourced from the codebase. (pyproject.toml[1]gundi_client_v2/__init__.py[2]Minor Fixes and Maintenance
tests/conftest.pytests/conftest.pyL83-R83)