Metadata-Version: 2.1
Name: gpt-engineer
Version: 0.0.8
Summary: Specify what you want it to build, the AI asks for clarification, and then builds it.
Project-URL: Homepage, https://github.com/AntonOsika/gpt-engineer
Project-URL: Bug Tracker, https://github.com/AntonOsika/gpt-engineer/issues
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: <4.0,>=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: black ==23.3.0
Requires-Dist: click >=8.0.0
Requires-Dist: mypy ==1.3.0
Requires-Dist: openai ==0.27.8
Requires-Dist: pre-commit ==3.3.3
Requires-Dist: pytest ==7.3.1
Requires-Dist: ruff ==0.0.272
Requires-Dist: termcolor ==2.3.0
Requires-Dist: typer >=0.3.2
Requires-Dist: rudder-sdk-python ==2.0.2
Requires-Dist: dataclasses-json ==0.5.7
Requires-Dist: tiktoken >=0.0.4
Requires-Dist: tabulate ==0.9.0
Requires-Dist: langchain >=0.0.240
Provides-Extra: doc
Requires-Dist: autodoc-pydantic >=1.8.0 ; extra == 'doc'
Requires-Dist: myst-parser >=0.18.1 ; extra == 'doc'
Requires-Dist: nbsphinx >=0.8.9 ; extra == 'doc'
Requires-Dist: sphinx >=4.5.0 ; extra == 'doc'
Requires-Dist: sphinx-autobuild >=2021.3.14 ; extra == 'doc'
Requires-Dist: sphinx-book-theme >=0.3.3 ; extra == 'doc'
Requires-Dist: sphinx-rtd-theme >=1.0.0 ; extra == 'doc'
Requires-Dist: sphinx-typlog-theme >=0.8.0 ; extra == 'doc'
Requires-Dist: sphinx-panels >=0.6.0 ; extra == 'doc'
Requires-Dist: toml >=0.10.2 ; extra == 'doc'
Requires-Dist: myst-nb >=0.17.1 ; extra == 'doc'
Requires-Dist: linkchecker >=10.2.1 ; extra == 'doc'
Requires-Dist: sphinx-copybutton >=0.5.1 ; extra == 'doc'
Requires-Dist: markdown-include >=0.6.0 ; extra == 'doc'
Requires-Dist: sphinx-copybutton >=0.5.2 ; extra == 'doc'
Provides-Extra: test
Requires-Dist: pytest >=7.3.1 ; extra == 'test'

# GPT Engineer

[![Discord Follow](https://dcbadge.vercel.app/api/server/8tcDQ89Ej2?style=flat)](https://discord.gg/8tcDQ89Ej2)
[![GitHub Repo stars](https://img.shields.io/github/stars/AntonOsika/gpt-engineer?style=social)](https://github.com/AntonOsika/gpt-engineer)
[![Twitter Follow](https://img.shields.io/twitter/follow/antonosika?style=social)](https://twitter.com/AntonOsika)


**Specify what you want it to build, the AI asks for clarification, and then builds it.**

GPT Engineer is made to be easy to adapt, extend, and make your agent learn how you want your code to look. It generates an entire codebase based on a prompt.

[Demo](https://twitter.com/antonosika/status/1667641038104674306)

## Project philosophy

- Simple to get value
- Flexible and easy to add new own "AI steps". See `steps.py`.
- Incrementally build towards a user experience of:
  1. high level prompting
  2. giving feedback to the AI that it will remember over time
- Fast handovers back and forth between AI and human
- Simplicity, all computation is "resumable" and persisted to the filesystem

## Usage

Choose either **stable** or **development**.

For **stable** release:

- `pip install gpt-engineer`

For **development**:
- `git clone https://github.com/AntonOsika/gpt-engineer.git`
- `cd gpt-engineer`
- `pip install -e .`
  - (or: `make install && source venv/bin/activate` for a venv)

**Setup**

With an OpenAI API key (preferably with GPT-4 access) run:

- `export OPENAI_API_KEY=[your api key]`

To set API key on windows check the [Windows README](./WINDOWS_README.md).

**Run**:

- Create an empty folder. If inside the repo, you can run:
  - `cp -r projects/example/ projects/my-new-project`
- Fill in the `prompt` file in your new folder
- `gpt-engineer projects/my-new-project`
  - (Note, `gpt-engineer --help` lets you see all available options. For example `--steps use_feedback` lets you improve/fix code in a project)

By running gpt-engineer you agree to our [terms](https://github.com/AntonOsika/gpt-engineer/blob/main/TERMS_OF_USE.md).

**Results**
- Check the generated files in `projects/my-new-project/workspace`


To **run in the browser** you can simply:

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/AntonOsika/gpt-engineer/codespaces)



## Features

You can specify the "identity" of the AI agent by editing the files in the `preprompts` folder.

Editing the `preprompts`, and evolving how you write the project prompt, is how you make the agent remember things between projects.

Each step in `steps.py` will have its communication history with GPT4 stored in the logs folder, and can be rerun with `scripts/rerun_edited_message_logs.py`.

## Vision
The gpt-engineer community is building the **open platform for devs to tinker with and build their personal code-generation toolbox**.

If you are interested in contributing to this, we would be interested in having you.

If you want to see our broader ambitions, check out the [roadmap](https://github.com/AntonOsika/gpt-engineer/blob/main/ROADMAP.md), and join
[discord](https://discord.gg/8tcDQ89Ej2)
to get input on how you can [contribute](.github/CONTRIBUTING.md) to it.

We are currently looking for more maintainers and community organisers. Email anton.osika@gmail.com if you are interested in an official role.


## Example

https://github.com/AntonOsika/gpt-engineer/assets/4467025/6e362e45-4a94-4b0d-973d-393a31d92d9b
