Added another code example to the readme #35
Conversation
This file contains 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
ReenigneArcher
suggested changes
Nov 28, 2023
| @@ -68,6 +68,19 @@ games_message.ParseFromString(byte_array) # Fills the protobuf message object wi | |||
| games = games_message.games | |||
| ``` | |||
|
|
|||
| Note that depending on what type of query you're doing, you will need to parse it differently. Consider the following example of getting covers with a Protobuf API request: | |||
There was a problem hiding this comment.
Suggested change
| Note that depending on what type of query you're doing, you will need to parse it differently. Consider the following example of getting covers with a Protobuf API request: | |
| > **Note** | |
| > Depending on what type of query you're doing, you will need to parse it differently. | |
| > Consider the following example of getting covers with a Protobuf API request. |
| @@ -68,6 +68,19 @@ games_message.ParseFromString(byte_array) # Fills the protobuf message object wi | |||
| games = games_message.games | |||
| ``` | |||
|
|
|||
| Note that depending on what type of query you're doing, you will need to parse it differently. Consider the following example of getting covers with a Protobuf API request: | |||
| ``` | |||
There was a problem hiding this comment.
Suggested change
| ``` | |
| ```py |
| covers_message.ParseFromString(byte_array) | ||
| covers = [cover.url for cover in covers_message.covers] | ||
| ``` | ||
| You may need to do some digging around in igdbapi_pb2.py (being careful not to actually edit anything) to look for similar functions to GameResult() and CoverResult() based on what you are trying to query for. |
There was a problem hiding this comment.
I'm not sure the final sentence is necessary or valuable. It is quite common to have to look through source code of various packages, especially ones that aren't so popular such as this one.
There was a problem hiding this comment.
I didn't know that this was necessary, especially considering my Python linter in VS Code did not pick up on GameResult() or CoverResult().
There was a problem hiding this comment.
Yea, I don't think any IDE would pick those up because of how they're added to the python globals.
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.
As a beginner to this wrapper and the API, I found the lack of documentation for using this API in Python to be very anti-beginner friendly, so I decided to add another use case example to the readme.