[JOSS-Review][Non-Blocking] Consider open-ai-key and hf-token as optional

souradipp76 / ReadMeReady

Tool for auto-generating README documentation for code repositories

https://souradipp76.github.io/ReadMeReady/

Apache License 2.0

1 stars 0 forks source link

[JOSS-Review][Non-Blocking] Consider open-ai-key and hf-token as optional #17

Open Manvi-Agrawal opened 4 days ago

Manvi-Agrawal commented 4 days ago

Consider making open-ai-key and hf-token as optional for running readme-ready cli, since these variables are useful only for openAI models; and the main objective of this tool is to to support open-source models since OpenAI api is costly.

souradipp76 commented 3 days ago

Hi @Manvi-Agrawal, I have made the OPENAI_API_KEY and HF_TOKEN an optional setup step for running the CLI app in the new release version 1.1.4. However, it is to be noted that some open-source models from HuggingFace do require HF_TOKENeven though they do not incur any cost. In those cases, the user needs to initialize their personal HuggingFace token before using the app.