add support for --list-software #1883
Conversation
…ntation of all easyconfig files rather than a full EasyConfig instance
|
@wpoely86 do you mind giving this a review before I add tests? Rendered result of |
|
@boegel for generating local documentation, would it make sense to add an option to only list installed software, or somehow highlight the ones that are already installed? Of course, there's |
|
@migueldiascosta that's a good idea, but maybe that should be a separate option like I think it's best to tackle that in a follow-up PR. |
boegel
changed the title
| @@ -924,7 +924,9 @@ def _generate_template_values(self, ignore=None, skip_lower=True): | |||
| # (eg the run_setp code in EasyBlock) | |||
|
|
|||
| # step 1-3 work with easyconfig.templates constants | |||
| template_values = template_constant_dict(self._config, ignore=ignore, skip_lower=skip_lower) | |||
| self.enable_templating = False | |||
There was a problem hiding this comment.
add a comment why you do this?
| @@ -514,6 +522,160 @@ def add_class(classes, cls): | |||
| return '\n'.join(txt) | |||
|
|
|||
|
|
|||
| def list_software(output_format=FORMAT_TXT, detailed=False): | |||
|
|
||
|
|
||
| def list_software_rst(software, detailed=False): | ||
| """Return overview of supported software in RST format""" |
|
Thanks for the review @wpoely86! |
TODO:
options:speed up parsing of easyconfigs significantly (involves profiling current codebase in detail)do not createEasyConfiginstances at all, and only parse what we really need (name,versionandtoolchainlines)implement support for cachingEasyConfiginstances into a file on disk (which also involves support for updating the cache, etc.)EasyConfiginstancessupport different levels of detail: only software names, also incl. versions, also incl. toolchains--list-software(equivalent with--list-software=simple) vs--list-software=detailedrstoutput formatversionsuffix