With the merge of #52, we need to update the README.md, examples and provide a thor script to query the user for the desired information and create the metadata file. Given that inspec2ckl now requires this information for full functionality we need to document it.
This would be like the generate_map function of csv2inspec.
An example of the metadata.json file should be in the examples/inspec2ckl directory in the project.
If the user does not provide a metadata.json file via the cli flags or it cannot find one in the local pwd then we could have it automatically run the generate_metadata interactive program to query the user for the needed information.
aaronlippold
commented
5 years ago
With the merge of #52, we need to update the README.md, examples and provide a thor script to query the user for the desired information and create the metadata file. Given that
inspec2cklnow requires this information for full functionality we need to document it.This would be like the
generate_mapfunction ofcsv2inspec.An example of the
metadata.jsonfile should be in theexamples/inspec2ckldirectory in the project.Perhaps we could use something like: https://github.com/piotrmurach/tty-prompt - to make it more interactive and allow us to set defaults.
Stretch goal:
If the user does not provide a
metadata.jsonfile via the cli flags or it cannot find one in the localpwdthen we could have it automatically run thegenerate_metadatainteractive program to query the user for the needed information.