DRY local configuration changes and apikey autoloading #3
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
Currently the config file path derivation logic is duplicated and defines a default name in $HOME instead of tucking itself into a utility directory. Establish a default ~/.nasdaq directory for possible configuration files and rename the apikey config file. Adds logic to check if the file path exists and add logic that tries hard to create the directories if they don't exist. Ideally the explicit call to read_key() should not be required by users and the client should attempt to set they key for convenience. A future commit will attempt to add read_key() convenience. Signed-off-by: Jamie Couture <jamie.couture@nasdaq.com>
Currently the data link library allows users to define a simple credential file where the api key is anticipated, but requires an explicit call to read_key(). Introduce convenience logic to set the api key in global configuration, if the file exist. Update documentation in support of read_key() convenience. Signed-off-by: Jamie Couture <jamie.couture@nasdaq.com>
ericvautour-quandl
approved these changes
Nov 16, 2021
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 series introduces a change to reduce duplication of configuration file derivation as well as tucking config files into a default standard path.
Building on top of the standard path, introduce apikey autoload. When imported, attempt to find the apikey in our standard path: if a file exists try to read it. Adds convenience to avoid unnecessary boilerpate; help prevent people from committing their api key.
A future topic will allow API key to be defined via environment variables.