search

tom-doerr / codex-readme

Revolutionize your project documentation with the Codex-README generator, utilizing OpenAI's Codex for intelligent README creation.
MIT License
395 stars 23 forks source link

No mention of how to get an API key #1

Closed allywilson closed 2 years ago

allywilson commented 2 years ago

The script requires an OpenAI key, but it's not mentioned anywhere that it is needed, or how to obtain one (additionally, no mention of the modules needed to install as well).

tom-doerr commented 2 years ago

Yes, the reason for this is that the readme was autogenerated and serves as an example for autogenerated readmes. I just updated the script so it tells you what module to install and where to register for Codex.

tom-doerr commented 2 years ago

Here's the information: You can obtain the API key after you get accepted for Codex (https://openai.com/blog/openai-codex/) and install the openai module using pip3 install openai.

pepa65 commented 1 year ago

How do I use/apply the key once obtained? I tried using --tokens but that didn't seem to be it.

tom-doerr commented 1 year ago

It should generate a config file for you where you can enter the key once you run it. The files should be at ~/.config/openaiapirc.

pepa65 commented 1 year ago

I had to do python3 -m pip install openai, just pip install openai didn't work...