An open API service indexing awesome lists of open source software.

https://github.com/fvhmifvreed/ai-prompt-generator

Desktop application built using Python and Kivy designed to help users generate and manage professional-level prompts
https://github.com/fvhmifvreed/ai-prompt-generator

ai ai-prompts kivy-framework openai python python3

Last synced: 7 months ago
JSON representation

Desktop application built using Python and Kivy designed to help users generate and manage professional-level prompts

Awesome Lists containing this project

README

          

# AI Prompt Generator

![Python](https://img.shields.io/badge/Python-3.8%2B-blue)
![Kivy](https://img.shields.io/badge/Kivy-2.0.0-yellowgreen)
![OpenAI](https://img.shields.io/badge/OpenAI-API-brightgreen)
![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)

The **AI Prompt Generator** is a desktop application built using Python and Kivy designed to help users generate and manage professional-level prompts for NLP tasks. It leverages the OpenAI API to rephrase input texts, allowing users to customize generated prompts. Generated prompts are stored in a SQLite database and can be exported to a CSV file for further analysis.

## 🌟 Features

- **Rephrase Prompt Generation**: Generate rephrased prompts using OpenAI's powerful language models.
- **Customizable AI Models**: Choose from a variety of OpenAI models like text-davinci-003, text-curie-001, text-babbage-001, and text-ada-001.
- **Creativity Control**: Adjust the temperature setting to control the creativity of the generated text.
- **Data Management**: Save and load prompts in a SQLite database for easy access and management.
- **Export Functionality**: Export saved prompts to a CSV file for sharing or external use.
- **User-Friendly Interface**: Intuitive UI built with Kivy to ensure accessibility and ease of use.

## 📦 Installation

To get started with the AI Prompt Generator, follow these steps:

1. Clone the repository:
```bash
git clone https://github.com/fvhmifvreed/ai-prompt-generator.git
cd ai-prompt-generator
```
2. Create a virtual environment (optional but recommended):
```bash
python -m venv venv
source venv/bin/activate # On Windows use `venv\Scripts\activate`
```
3. Install project dependencies:
```bash
pip install kivy openai
```
4. Set up your OpenAI API key:

Replace 'your-openai-api-key' in `ai_prompt_generator.py` with your actual OpenAI API key.

## 🚀 Usage

Run the application with:
```bash
python ai_prompt_generator.py
```

- **Input Seed Text**: Enter the text you would like to rephrase in the text input field.
- **Select AI Model & Adjust Temperature**: Choose a preferred AI model and adjust the temperature slider to control how creative the rephrased prompt should be.
- **Generate Prompt**: Click the "Rephrase Prompt" button to generate a new rephrased prompt.
- **Save & Manage Prompts**: Use the "Save Prompt" button to store generated prompts, "Load Previous Prompts" to review them, and "Export to CSV" to download them as a CSV file.

## 🛠️ Technologies Used

- **Python**: Core programming language.
- **Kivy**: Framework for creating the graphical user interface.
- **SQLite**: Database for storing generated prompts.
- **OpenAI**: External API used for generating prompt rephrases.

## 🤝 Contributing

Contributions are welcome! Please follow these guidelines:

1. Fork the repository.
2. Create a new feature branch (`git checkout -b feature-branch`).
3. Commit your changes (`git commit -m 'Add new feature'`).
4. Push your branch (`git push origin feature-branch`).
5. Open a Pull Request.

## 📜 License

This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

## 🙏 Acknowledgments

- Thanks to the [Kivy](https://kivy.org/) development team for their incredible work on the framework.
- Special thanks to [OpenAI](https://openai.com/) for providing the API that makes this possible.