Skip to content
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

Setup CLI #401

Open
wants to merge 92 commits into
base: main
Choose a base branch
from
Open

Setup CLI #401

wants to merge 92 commits into from

Conversation

tieneupin
Copy link
Contributor

@tieneupin tieneupin commented Nov 11, 2024

Adds a command line tool intended to walk non-developers through the process of setting up a configuration file in order to run Murfey properly.

Key Changes:

  • The Security class has been renamed to GlobalConfig, and functions referring to it have likewise been renamed.
    • Murfey will likewise now look for the MURFEY_GLOBAL_CONFIGURATION environment variable instead of MURFEY_SECURITY_CONFIGURATION.
  • Many MachineConfig keys have been re-typed to take Optional[Path] instead of str as part of making more parts of the Murfey workflow optional for other users. The code parsing logic has been changed to reflect this.

Copy link

codecov bot commented Nov 11, 2024

Codecov Report

Attention: Patch coverage is 15.56196% with 586 lines in your changes missing coverage. Please review.

Project coverage is 25.46%. Comparing base (42a774a) to head (9167512).
Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #401      +/-   ##
==========================================
- Coverage   27.20%   25.46%   -1.75%     
==========================================
  Files          75       76       +1     
  Lines       10101    12250    +2149     
  Branches     1337     1797     +460     
==========================================
+ Hits         2748     3119     +371     
- Misses       7263     9013    +1750     
- Partials       90      118      +28     

@tieneupin tieneupin self-assigned this Nov 13, 2024
@d-j-hatton
Copy link
Contributor

If nothing is added to something with a default can we give the option to choose to use the default?

@d-j-hatton
Copy link
Contributor

Can we have (y/n) in a different colour to make it clear you should answer with a yes or no?

@d-j-hatton
Copy link
Contributor

The recipe keys can be a literal

@d-j-hatton
Copy link
Contributor

If a section is disabled then the rest of the keys for the section can be skipped

…s received; updated 'data_directories' creation function to reflect change in MachineConfig
@tieneupin
Copy link
Contributor Author

tieneupin commented Jan 6, 2025

As of the time of this writing, the following discussed changes have been implemented:

  • If a section is disabled then the rest of the keys for the section can be skipped
  • The recipe keys can be a literal
  • Can we have (y/n) in a different colour to make it clear you should answer with a yes or no?
  • If nothing is added to something with a default can we give the option to choose to use the default?
  • Could we leave (press Enter to leave it blank as '') out for non-strings

The following changes are still needed:

  • In the tests the environment variables need setting back to MURFEY_SECURITY_CONFIGURATION

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request server Relates to the server component
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants