Skip to main content

A CLI tool for refactoring Python code using OpenAI's text-davinci-003 model

Project description

Codegpt

A tool for using GPT just a little quicker. A nearly truly automated footgun. Learn how to revert with git before trying please.

Getting Started

pip install codegpt

And set your openapi API key as an environment variable like they recommend: In their docs here

Windows users can also use setx like:

$ setx OPENAI_SECRET_KEY=<YOUR_API_KEY>

from an admin console.

Then find a file you hate (Back it up! Don't do it live!) and give it a shot.

codegpt refactor .\helper.py "Break this up into smaller functions where you can. Add google style docstrings. Feel free to rewrite any code doesn't make sense."

You'll see something like:

This prompt is 254 tokens, are you sure you want to continue?
The most GPT-3 can return in response is 3843. [y/N]: y

(and after a short wait...)

Explanation: The code has been refactored into smaller functions to improve readability, and Google style docstrings have been added.

Other things to try:

  • codegpt edit - For editing markdown files, including code blocks. Hello, blog editor!
  • codegpt varnames - Changes variable names (and supposed to only be variable names...) to be readable
  • codegpt comment - Automatically add comments to a file.

Propose endpoints as issues, I've got a few ideas:

  • Explain file
  • Write tests for file
  • Generate SQL query from table spec files
  • Generate new file
  • Generate documentation from a file

Just remember this is paid - 2 cents per 1k tokens is a lot when you're working on files with a few hundred lines.

And remember to break up what you're working on - Results will be better with less moving parts and things to do.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

codegpt-0.0.7.tar.gz (16.7 kB view details)

Uploaded Source

Built Distribution

codegpt-0.0.7-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

Details for the file codegpt-0.0.7.tar.gz.

File metadata

  • Download URL: codegpt-0.0.7.tar.gz
  • Upload date:
  • Size: 16.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.10.6 Windows/10

File hashes

Hashes for codegpt-0.0.7.tar.gz
Algorithm Hash digest
SHA256 67d381f082be9f15cbe18d4db2274f60f5310e3e5b406fd91da377a786adfe15
MD5 f525cd42b68fcbe1fa5638b306b98f9e
BLAKE2b-256 9031b4238473a8753cf399ec0af2d6ccc9cf2836a69ab89e0ac6ff5a6d494de6

See more details on using hashes here.

File details

Details for the file codegpt-0.0.7-py3-none-any.whl.

File metadata

  • Download URL: codegpt-0.0.7-py3-none-any.whl
  • Upload date:
  • Size: 16.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.14 CPython/3.10.6 Windows/10

File hashes

Hashes for codegpt-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 8f74fabbb2d6118d81b6c0ab8b282beff3c0b0a7a1afa40ee59909930f5b2ab2
MD5 e549a9ebf6ba08198ab192221df20fb8
BLAKE2b-256 41efea8885fda3f95f8aba02a6432ba924fc4b8291e1000fc6263f1254afab1f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page