docstrings_generators

class gpt4docstrings.docstrings_generators.base.DocstringGenerator[source]

An abstract base class for docstring generators that provides a blueprint for generating docstrings for functions and classes.

generate_docstring(source: str) -> dict: Generate a docstring for the provided source code.

class gpt4docstrings.docstrings_generators.chatgpt_generator.ChatGPTDocstringGenerator(api_key: str, model_name: str, docstring_style: str)[source]: A class for generating Python docstrings using ChatGPT.