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.

Posting about progress here:

Twitter Follow

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.

Be careful! But let's go.

The fun stuff is in the unsafe command.

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

codegpt unsafe edit .\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 unsafe edit - Try it with anything. Markdown blog posts, js, yaml, python, whatever.
  • codegpt unsafe varnames - Changes variable names (and supposed to only be variable names...) to be readable
  • codegpt unsafe 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.9.tar.gz (18.2 kB view details)

Uploaded Source

Built Distribution

codegpt-0.0.9-py3-none-any.whl (19.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: codegpt-0.0.9.tar.gz
  • Upload date:
  • Size: 18.2 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.9.tar.gz
Algorithm Hash digest
SHA256 e15f5b4c92d44b2c4e127513ccb3be5213f282efc14c00c418b63db41ee80b8e
MD5 754b6adba0ab51ca59c213f260918e5b
BLAKE2b-256 5f7c5b5be8c8d9f3cc09bc9158d225dfe1f0d97196d76283c89024e66d47db52

See more details on using hashes here.

File details

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

File metadata

  • Download URL: codegpt-0.0.9-py3-none-any.whl
  • Upload date:
  • Size: 19.1 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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 109c068b398a96c0e51c2375fca9ea0ea2a5147b5bbcc3cf772ee93f401dcfbb
MD5 d90341ece4dfb9fd030760d59cedd119
BLAKE2b-256 eba8b3d51c166cd759be96fb4381cf8fda44f3504ec68fbb31b079345d5825be

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