/program-engineer-gpt

Interact directly with code repositories in a chat or automate the development of your code based just on a project description

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

ProgramEngineerGPT

Kitty Kitty Meow Moew

Status GitHub Issues Twitter Follow

ProgramEngineerGPT is an interactive command line tool that leverages the power of AI to assist developers with code comprehension, exploration, and generation. It serves as a virtual assistant that can analyze codebases, answer queries about code, and even help in setting up new coding projects.

Table of Contents

About

ProgramEngineerGPT is an AI-powered tool designed to assist developers with code comprehension, exploration, and generation. ProgramEngineerGPT can be used as a comprehensive developer's assistant that can understand code at a deep level and can provide valuable insights and assistance. Whether you're trying to understand a complex codebase or starting a new project, ProgramEngineerGPT can be run using two modes of operation

  • Analyze Mode
  • Develop Mode.

Analyze Mode

In the 'Analyze' mode, ProgramEngineerGPT will thoroughly examine a provided code repository. You will be engaged in an interactive chat session where you can pose queries about the codebase. This could include questions about its structure, dependencies, functions, or any other aspect. The AI will respond with insights, helping you gain a deeper understanding of the code repository and how it funtions.

Develop Mode

In the 'Develop' mode, ProgramEngineerGPT can assist you in setting up a new coding project. This includes planning the project structure, setting up the development environment, and other setup tasks. You will enter an interactive session where you will provide a project description of the program/project you want to create. After you provide a project description, the AI system will ask further questions to gather more information about your project. Your responses will guide the AI in providing the best assistance for your project.

Features:

  • Setup a Coding Project: ProgramEngineerGPT can help you set up a new coding project, including planning the project structure and setting up the development environment.
  • Gathers Program Requirements and Architecture: It can ask you questions about your project to gather more information and understand your project requirements and desired architecture.
  • Creates a Project Directory Structure: Based on your project requirements, ProgramEngineerGPT can create a suitable directory structure for your project.
  • Generates Initial Code: It can generate initial code for your project based on the gathered requirements and architecture.
  • Generates Unit Testing: ProgramEngineerGPT can generate unit tests for your code to ensure its correctness and robustness.
  • Generates Code Documentation: It can generate documentation for your code base, making it easier for others to understand and contribute to your project.

Getting Started

These instructions will get you a copy of the project up and running for development and testing purposes.

Prerequisites

Known Issues

ChromaDB Fails to Install on MacOS:

# Failed Command
pip install chromadb

To address this issue, please run the following command:

export HNSWLIB_NO_NATIVE=1

Setup

Instructions on how to get ProgramEngineerGPT configured locally.

Before running, it is important that you have the correct environmental variables set. Setup required Environmental Variables. You can either change the test.env to .env and add the required environmental variables.

If you would like to export them locally, please use the following keys.

Linux or MacOS

# OpenAI API
export OPENAI_API_KEY="<OPENAI_API_KEY>"

Windows

# OpenAI API
setx OPENAI_API_KEY <OPENAI_API_KEY>

Clone the repository

#Download Repo and Navigate to Directory
git clone https://github.com/hackedbyagirl/program-engineer-gpt.git
cd program-engineer-gpt

Install all the required packages

python3 -m pip install -r requirements.txt

Usage

You can start using ProgramEngineerGPT by running the main script and selecting the mode of operation. Depending on the mode, you will be asked to provide further details such as the code repository URL or the project description.

However, this program does depend on API keys so make sure to set them!

# Python program
python3 programengineergpt.py

Examples

Program Launch

Main Program Home Screen

main

Analyze Mode

Loading Code of Current Working Directory

cwd

Engaging in conversation about the code

chat

Develop Mode

Providing Developer Mode with a Project Description

dev

Engaging with Developer AI Assistant

dev2

Contributing

Contributions are welcome! Please refer to the contributing guide provided in the repository.

License

Please refer to the license file provided in the repository.

Acknowledgements

Inspiration