Skip to main content

Write code using OpenAI's Codex model

Project description

writecode

writecode is a command-line tool that generates code from text prompts using OpenAI's Codex model. With writecode, you can quickly and easily generate code snippets in a variety of languages without having to write any code yourself.

Installation

To install writecode, you will need to have Python 3 and pip installed on your system. Then, you can use pip to install the writecode package from PyPI:

pip install writecode

Usage

The main function in writecode is writecode.code, which takes the following keywords:

  • prompt (required): A string containing the text prompt with the instructions for Codex.
  • lang (optional): The language to generate code in. The default is Python.
  • max_tokens (optional): An integer specifying the maximum number of output tokens.
  • best_of (optional): An integer specifying the number of completions to generate server-side and return the "best" (the one with the highest log probability per token). The default is 3.
  • save (optional): The name of the output file to save the code snippet to.

Here's an example of how to use the code function to generate a Python code snippet and save it to a file:

from writecode import code

prompt = "Write a function that takes a list of integers and returns the sum of the even numbers in the list."
code(prompt, lang='python', max_tokens=1000, save='output.py')

This will generate a Python code snippet, followed by an explanation, with up to 1000 tokens and save it to a file called output.py.

Example output:

def sum_even(list):
    sum = 0
    for i in list:
        if i % 2 == 0:
            sum += i
    return sum

print(sum_even([1,2,3,4,5,6,7,8,9,10]))

# The function takes a list of integers and returns the sum of the even numbers in the list.
# The function first creates a variable called sum and sets it equal to 0.
# The function then loops through the list and checks if the number is even.
# If the number is even, the function adds it to the sum variable.
# The function then returns the sum variable.
# The function is then called and the list is passed as an argument.
# The function returns the sum of the even numbers in the list.

Supported Languages

writecode currently supports code generation for the following languages:

  • Python
  • HTML
  • C++
  • Java
  • JavaScript
  • C#
  • Go
  • Ruby
  • Swift
  • PHP

This list is not exhaustive and may be updated in the future as the Codex model continues to evolve.

Limitations

writecode is powered by OpenAI's Codex model, which is a powerful tool for generating code from text prompts. However, it is not perfect and may not always produce accurate or complete code snippets. It is important to carefully review the generated code before using it in any production systems.

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

writecode-0.1.2.tar.gz (3.4 kB view details)

Uploaded Source

Built Distribution

writecode-0.1.2-py2.py3-none-any.whl (4.2 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file writecode-0.1.2.tar.gz.

File metadata

  • Download URL: writecode-0.1.2.tar.gz
  • Upload date:
  • Size: 3.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.12

File hashes

Hashes for writecode-0.1.2.tar.gz
Algorithm Hash digest
SHA256 9d249ae7ffbf8a1b9298f101163ad7f41daa14a34dce7659187d439a1e91929a
MD5 0d37e39cc4b412a7ac5200f1c66c94ae
BLAKE2b-256 2843d237d1f7801ceb9e0a6ba680ab2ec2365bdc5a641b2fca07b137961ac7d6

See more details on using hashes here.

File details

Details for the file writecode-0.1.2-py2.py3-none-any.whl.

File metadata

  • Download URL: writecode-0.1.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 4.2 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.12

File hashes

Hashes for writecode-0.1.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 03b033df886e5ee3f31f64732afa400a3a086f781774b30639743c5bc9aab83b
MD5 5f12b2acd576ba8e8a2514076e0a4d41
BLAKE2b-256 0bf2068056c17b75071b510869b7998e289d62eb0a7bd9083c461f33c6bf9460

See more details on using hashes here.

Supported by

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