csaf-tools / CVRF-CSAF-Converter

A CVRF CSAF Converter, taking care about OASIS specification.
https://www.telekom.com/security
MIT License
10 stars 4 forks source link

Clarify location of config file #93

Closed tschmidtb51 closed 2 years ago

tschmidtb51 commented 2 years ago

Originally, we discussed to have a command line option (e.g. -c) to provide a config file. That was not implemented.

However, it is currently unclear where the config file is when it is installed a) directly from GitHub (in the venv as described) b) via pip

Please clarify that in the README.

sustefil commented 2 years ago

Hi @tschmidtb51,

It's already in the readme, both a) and b) install the config file inside the site-package

https://github.com/csaf-tools/CVRF-CSAF-Converter/blob/main/README.md#config

tschmidtb51 commented 2 years ago

@sustefil

Sorry, I might be missing something here:

  1. What does the ... refer to?
  2. When cloned from GitHub and installed in the venv: Where is the folder site-packages/? Maybe having a path that starts with $ROOT_DIR could help...
  3. When installing from PyPI: Where is the folder site-packages/?
tschmidtb51 commented 2 years ago

BTW: I guess "Convertor" in the last sentence of the linked section in the Readme should actually be a "Converter"...

sustefil commented 2 years ago

Fixed the readme to be more explicit

https://github.com/csaf-tools/CVRF-CSAF-Converter/blob/main/README.md#config

sustefil commented 2 years ago

@tschmidtb51 can be closed?

tschmidtb51 commented 2 years ago

@sustefil: Yes. Please do not forget to mention issue numbers in commits. It makes the life and reviewing much easier. Thanks!