Metadata-Version: 2.4
Name: craft-prompt-generator
Version: 1.0.0
Summary: An AI-powered Python library for generating, refining, scoring, translating, and exporting prompts using the CRAFT framework.
Author-email: Satej Gujar <satejgujar198@gmail.com>
License: MIT License
        
        Copyright (c) 2026 Satej Gujar
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
Project-URL: Homepage, https://github.com/SatejGujar25/prompt-generator
Project-URL: Repository, https://github.com/SatejGujar25/prompt-generator
Project-URL: Issues, https://github.com/SatejGujar25/prompt-generator/issues
Keywords: prompt,prompt engineering,craft,llm,groq,ai,generator
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: groq>=0.37.1
Dynamic: license-file

# Prompt Generator

An AI-powered Python library for generating, refining, scoring, translating, and exporting high-quality prompts using the **CRAFT Prompt Engineering Framework**.

---

## ✨ Features

- AI-powered prompt generation
- CRAFT framework-based prompt creation
- Prompt quality scoring using AI
- Prompt refinement for improved clarity and effectiveness
- Prompt translation into multiple languages
- Export prompts as UTF-8 text files
- Clean and beginner-friendly API
- Modular and scalable architecture

---

## 🚀 Version

Current Version: **v1.0.0**

### Included Features

- Generate Prompt
- Score Prompt
- Refine Prompt
- Translate Prompt
- Export Prompt (.txt)

---

## 📦 Installation

Clone the repository

```bash
git clone https://github.com/SatejGujar25/prompt-generator.git
```

Move into the project directory
SOFTWARE.

```bash
cd prompt-generator
```

Install the required packages

```bash
pip install -r requirements.txt
```

---

## ⚙️ Requirements

- Python 3.10+
- Groq API Key

---

## 📂 Project Structure

```
AI_Prompt/
│
├── prompt_generator/
│   ├── __init__.py
│   ├── generator.py
│   ├── llm.py
│   ├── craft.py
│   ├── scorer.py
│   ├── refiner.py
│   ├── translator.py
│   └── exporter.py
│
├── examples/
│
├── README.md
├── LICENSE
├── requirements.txt
└── pyproject.toml
```

## 📖 API

### PromptGenerator

| Method | Description |
|----------|-------------|
| `gen_prompt(n)` | Generates one or more prompts |
| `Score()` | Evaluates prompt quality |
| `Refine_prompt()` | Improves an existing prompt |
| `Translate(language)` | Translates the prompt |
| `Export(filename)` | Exports prompt to a UTF-8 text file |

---

## 🧠 Framework

Prompt Generator internally uses the **CRAFT Prompt Engineering Framework**.

- **C** – Context
- **R** – Role
- **A** – Action
- **F** – Format
- **T** – Task

The generated prompt is returned as a natural paragraph while internally preserving all CRAFT components.

---

## 📌 Roadmap

### ✅ Version 1.0

- Prompt Generation
- Prompt Scoring
- Prompt Refinement
- Prompt Translation
- TXT Export

## 🤝 Contributing

Contributions, suggestions, and improvements are always welcome.

Feel free to fork the repository and submit a pull request.

---

## 📄 License

This project is licensed under the MIT License.

---

## 👨‍💻 Author

**Satej Gujar**

---

## ⭐ Support

If you find this project useful, consider giving it a ⭐ on GitHub.
