-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Migrate from ENV to YAML config #59
Merged
Merged
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
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
Quality Gate passedKudos, no new issues were introduced! 0 New issues |
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.
Summary
This PR addresses the migration from using an ENV file as an config to YAML. The rationale for moving is that it's hard to work with ENV files, and as pointed by Diamond, an ENV file is not an config. ENV files only store strings, so it makes it hacky to try and implement values that are required to be int or bool. For this project, environs was used to bypass this hacky behavior by serializing the key value pairs into native Python types through Marshmallow. This puts an burden on the original problem, which is the format itself. After considering many other formats (including JSON and TOML), YAML was selected as there is an yaml parser library through PyYAML (w/ libyaml bindings), and YAML is a superset of JSON. This makes it easier to understand, as platforms such as GitHub already use YAML extensively, and it's very easy to pick up and learn. Migration should not be hard. In addition, the config system is written in a way where it would be trivial to swap to another config format, such as TOML as all is needed to change is the parser within
RodhajConfig.load_from_file
This PR also adjusts the Docker Compose settings to use an custom ENV file instead.
Namely, some tasks that need to be dealt with before merging are noted:
Types of changes
What types of changes does your code introduce to Rodhaj
Put an
x
in the boxes that applyChecklist
Put an
x
in the boxes that apply