Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 1.18 KB

README.md

File metadata and controls

36 lines (27 loc) · 1.18 KB

documentation generator for python (for now)

this is an automatic documentation generator using generative ai made in python.
this should not be used in production-ready apps. it is not a replacement for actual humans.

IMPORTANT NOTES

the encryption process can change your code. this CAN use a HUGE amount of tokens if your codebase is big. PLEASE DO NOT use this on actual projects.
this is just a proof of concept and is NOT a finalized product.

how do i use this?

its current in development, so you cannot use it :3
soon though.

what does this do?

this aims to give users a fast and easy way to generate docstrings/documentation for their python programs (for now only python)

how does it work?

it uses python's ast module to parse the code into an ast, then processes it using google gemini's api key to generate a suitable summary of the code.

development progress

oh man

completed

code parser data compression basic ai prompt

in progress

ai analyzer

planned features

multi file support docstring detection + analyzing
ai integration
github actions support (for things like auto docuentations on push)