codebuddie 0.0.3

codebuddie is a Python-based command-line interface (CLI) utility that uses OpenAI chatGPT API to help you in updating comments, docstring, module docstings in your code

codebuddie: CLI

To install codebuddie -

run the following command in your terminal -

pip install codebuddie

Now following are the ways you can use codebuddie -

NOTE: set OPENAI_API_KEY as an environment variable before using codebuddie

It can update code with proper comments, docstring, and module docstrings in the following scenarios:

1. If pointed to a local directory. [TODO]

codebuddie -d path/to/source/directory

or

codebuddie --dir path/to/source/directory

or

codebuddie -d path/to/source/directory -o path/to/destination/directory

1. If pointed to a github repository. [TODO]

codebuddie -s link/to/github_repository

or

codebuddie --src link/to/github_repository

or

codebuddie -s link/to/github_repository -o link/to/destination/directory