🤖 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
1 maintainer
Metadata
1 maintainer
Release files for codex-readme 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| codex-readme-0.1.0.tar.gz | 4.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| codex_readme-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 6.7 kB
Release files / codex-readme-0.1.0.tar.gz
| Download URL | codex-readme-0.1.0.tar.gz |
|---|---|
| Size | 4.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
89e190947f5ba937a86519786dbfe7f88c87c473e0967eb13b9667f0e1030a81
|
|
BLAKE2b-256 checksum How to use checksums |
8da2e11ab4ff80dd6835144a4e619265fda6aa46493efad10f5b1e8673ebbadb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
Release files / codex_readme-0.1.0-py3-none-any.whl
| Download URL | codex_readme-0.1.0-py3-none-any.whl |
|---|---|
| Size | 2.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
cf31b8362eb16909d351fbafadd91b8123bbdb27339bf8e4aba7b97f85066f24
|
|
BLAKE2b-256 checksum How to use checksums |
9a29540d1cfd1d62b05e1dab59165315a31554f812121f733253690377d55664
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is 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
|
