Alpha 10 #76
Merged
Alpha 10 #76
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
There was a problem hiding this comment.
Pull Request Overview
This PR, titled "Alpha 10", prepares the new pre-release version of the Gallagher SDK by updating version metadata, dependency versions, and documentation headings while also revising some operational code in the SDK core module.
- Bumped project and dependency versions in pyproject.toml.
- Removed a timeout parameter in the HTTP call within the core module.
- Updated documentation for consistent heading capitalization and corrected a typographical error.
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| pyproject.toml | Updated version and bumped dependency versions for Pydantic, Black, and Rich. |
| gallagher/cc/core.py | Removed the explicit timeout parameter in the polling request. |
| docs/docs/python-sdk.md | Adjusted section headings and added a warning block; fixed a typographical error in the library name. |
| docs/docs/installation.md | Revised documentation headings to improve stylistic consistency. |
Comments suppressed due to low confidence (2)
gallagher/cc/core.py:528
- Removing the timeout parameter may result in indefinite wait times if the endpoint does not respond. Please review this change to ensure it does not introduce unintended blocking behavior.
timeout=TRANSPORT.TIMEOUT_POLL, # Next Gallagher CC wait
docs/docs/python-sdk.md:31
- It appears that 'pyndatic' is a typographical error. Consider correcting it to 'pydantic'.
These are built using the much loved [pyndatic](https://pydantic.dev) library.
i thought the timeout parameter was causing the endpoint not to return in a timely manner, but turns out that the command centre takes the first x seconds to formulate the responses and then the follow works properly
fixes validation rules identified in #77 as part of a customer project implementation, also update the field name translation function to handle snake_case of outliers like PINNumber -> pin_number or PIN Number -> pin_number
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.
📢 Preamble
A release to refactor the way PDF fields are accessed, documentation was update to reflect this.
💅 Improvements
The
pdfattribute is dynamically populated object with dynamically generated keys. Here are some examples of howPDFfield names are mapped tosnake_casekeys:@Cardholder UIDwould becomepdf.cardholder_uid@Citywould becomepdf.city@Company Namewould becomepdf.company_name@PINNumberwould becomepdf.pin_number🛠️ Fixes
dto/summary/pdf.pyrelaxes theHreffield requirement, they are nowOptionalHrefwith a default ofNonepersonal_data_fieldvalidation fails forCardDetail#77