Metadata-Version: 2.1
Name: PyLLMut
Version: 0.4.0
Summary: An LLM-driven mutant generator library for Python
Author-email: Mohammad Rezaalipour <rezaalipour.mohammad@gmail.com>
Maintainer-email: Mohammad Rezaalipour <rezaalipour.mohammad@gmail.com>
License: The MIT License (MIT)
        
        Copyright (c) 2024 Mohammad Rezaalipour
        
        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://pyllmut.readthedocs.io
Project-URL: Bug Reports, https://github.com/mohrez86/pyllmut/issues
Project-URL: Source, https://github.com/mohrez86/pyllmut
Keywords: LLM,Mutation,Python
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
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: Programming Language :: Python :: 3 :: Only
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: openai~=1.58.1

# PyLLMut

[![PyPI version](https://badge.fury.io/py/pyllmut.svg)](https://badge.fury.io/py/pyllmut)
[![PyPI Downloads](https://static.pepy.tech/badge/pyllmut)](https://pepy.tech/projects/pyllmut)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE.txt)
[![Docs](https://readthedocs.org/projects/pyllmut/badge/?version=latest)](https://pyllmut.readthedocs.io/en/latest/)
![Status](https://img.shields.io/badge/Status-Experimental-orange)
![Research](https://img.shields.io/badge/Research-Driven-lightgrey)
![Open Source](https://img.shields.io/badge/Open%20Source-Yes-brightgreen)
[![Tests](https://github.com/mohrez86/pyllmut/actions/workflows/test-all.yml/badge.svg)](https://github.com/mohrez86/pyllmut/actions/workflows/test-all.yml)

## Introduction

PyLLMut—pronounced "Pill Moot" (/pɪl muːt/)—is 
a research-based LLM-driven mutant generator library 
for Python. It uses Large Language Models (LLMs) to 
generate mutants for Python programs.
The current version of PyLLMut 
supports `GPT-4o` and `GPT-4o mini` through their APIs. 
We plan to add support for more models, 
such as *DeepSeek-R1*.

## Documentation  

Full documentation is available at
[PyLLMut Documentation](https://pyllmut.readthedocs.io).  

## Installation  

To install PyLLMut, follow the instructions in the 
[Installation Guide](https://pyllmut.readthedocs.io/en/latest/user/install).  

## Usage  

For a quick example of how to use PyLLMut, refer to the 
[Quick Start Guide](https://pyllmut.readthedocs.io/en/latest/user/start).  

## API Reference  

For details on PyLLMut's available API, refer to the 
[API Reference](https://pyllmut.readthedocs.io/en/latest/api/generator).  

## Acknowledgments  

PyLLMut is a research-based project, inspired by the study 
[On the Use of Large Language Models in 
Mutation Testing](https://arxiv.org/abs/2406.09843), which was 
originally for Java.
