This tool generates readmes using Codex

Project description

🤖 codex-readme 📜

The gif shows how the readme below was generated. To generate your own readmes you need to get access to the Codex API (https://openai.com/blog/openai-codex/).

codex-readme

What is it?

This project is a set of programs that I use to create a README.md file.

How does it work?

It reads program files and concatenates the beginning of all files to create a input prompt which is then fed to OpenAI Codex to generate a README.

How to use it?

./codex_readme.py

TODO

Add more programs and improve the README.md generator.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Credits

This project is based on the OpenAI Codex project.

Contact

If you have any questions or would like to get in touch, please open an issue on Github or send me an email: tom.doerr@tum.de

Project details

Release history Release notifications | RSS feed

This version

0.1.0

Oct 19, 2021

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codex-readme-0.1.0.tar.gz (4.3 kB view details)

Uploaded Oct 19, 2021 Source

Built Distribution

codex_readme-0.1.0-py3-none-any.whl (2.5 kB view details)

Uploaded Oct 19, 2021 Python 3

File details

Details for the file codex-readme-0.1.0.tar.gz.

File metadata

Download URL: codex-readme-0.1.0.tar.gz
Upload date: Oct 19, 2021
Size: 4.3 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.10

File hashes

Hashes for codex-readme-0.1.0.tar.gz
Algorithm	Hash digest
SHA256	`89e190947f5ba937a86519786dbfe7f88c87c473e0967eb13b9667f0e1030a81`
MD5	`62856196e78a476eb3e0368eea644251`
BLAKE2b-256	`8da2e11ab4ff80dd6835144a4e619265fda6aa46493efad10f5b1e8673ebbadb`

See more details on using hashes here.

Provenance

File details

Details for the file codex_readme-0.1.0-py3-none-any.whl.

File metadata

Download URL: codex_readme-0.1.0-py3-none-any.whl
Upload date: Oct 19, 2021
Size: 2.5 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.8.10

File hashes

Hashes for codex_readme-0.1.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`cf31b8362eb16909d351fbafadd91b8123bbdb27339bf8e4aba7b97f85066f24`
MD5	`ced3d1a718c86a2098425685c180f347`
BLAKE2b-256	`9a29540d1cfd1d62b05e1dab59165315a31554f812121f733253690377d55664`