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
Project description
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 usingcodebuddie
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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
codebuddie-0.0.3.tar.gz
(9.2 kB
view hashes)
Built Distribution
codebuddie-0.0.3-py3-none-any.whl
(10.3 kB
view hashes)
Close
Hashes for codebuddie-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 058f3ae5dac98aaa723add3f63a67536c559150f801762d13e9bd2cdc2d52775 |
|
MD5 | 5f74b6ad6104a70b2ed0cd739306e5fd |
|
BLAKE2b-256 | 131bcf5e8a33235e6dfbcb78aa8c10066854a7a40aa09650239fdcdffce97d05 |