Major refactor of code to eliminate the need to provide apikey on every function call #49
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
|
Not a contributor here but I'm wondering if this could be done with backwards compatibility in mind. E.g. keep |
EDIT: This version keeps apikey as optional parameter.
psohn
reviewed
Jul 20, 2024
| :return: A list of dictionaries. | ||
| """ | ||
| path = f"commitment_of_traders_report/list" | ||
| query_vars = {"apikey": apikey} | ||
| query_vars = {"apikey": apikey} if apikey else {"apikey": API_KEY} |
There was a problem hiding this comment.
Suggested change
| query_vars = {"apikey": apikey} if apikey else {"apikey": API_KEY} | |
| query_vars = {"apikey": apikey or API_KEY} |
nit
should work and be a little more concise but doesn't really matter
There was a problem hiding this comment.
also wondering (maybe not in the scope of this work) if an error should be raised if neither an apikey nor API_KEY are supplied
Co-authored-by: Philip Sohn <46043263+psohn@users.noreply.github.com>
|
+1 for merging this 🙏 |
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 substantive PR changes all functions within the module to eliminate the need to call apikey as part of every function call. Instead users will need to add an environment variable named FMP_API_KEY which will automatically be read.