feddernico / promptgpt

A Jupyter Notebook to help you write prompts efficiently

promptGPT: IPyWidgets Interactive Prompt Generator

A Jupyter Notebook to help you write prompts efficiently

Description

promptGPT is a Python-based project that leverages Jupyter widgets to offer an interactive user interface for prompt generation. This tool allows users to easily select different subject areas (e.g., Interpret Code, Generate Data, Data Science, Machine Learning, etc.) and generate corresponding prompts to guide their queries or tasks.

Features

• Interactive Dropdown: Allows users to select the subject area.
• Customizable Textarea: Provides space for users to modify the prompt.
• Generate Prompt Button: One-click operation to display the generated prompt.

Requirements

• Python 3.x
• Jupyter Notebook or Jupyter Lab
• IPyWidgets
• IPython

Installation

To install the required packages, run the following commands:

pip install ipywidgets
pip install IPython

Usage

1. Open a new Jupyter Notebook.
2. Paste the code into a new cell.
3. Run the cell to initialize the widgets.
4. Use the dropdown to choose the subject area.
5. Use the textarea to enter or modify your prompt.
6. Click the "Generate Prompt" button to display the formatted prompt.

Code Structure

• subject_widget: Dropdown for subject selection.
• input_widget: Textarea for prompt customization.
• update_value: Function to update the textarea based on selected subject.
• on_button_clicked: Function to display the generated prompt upon button click.

Contributing

If you have suggestions for how promptGPT could be improved, feel free to open an issue or create a pull request.

License

This project is licensed under the GNU General Public License v3.0.

---

This should provide a comprehensive guide for anyone interested in your project. Given your interest in both leading data science initiatives and disseminating knowledge through your blog, maintaining high-quality documentation like this README can be very beneficial. Would you like to discuss any specific section in more detail?