Skip to content

Commit 7ac6108

Browse files
committed
chore: release 1.0.0
1 parent f5f3970 commit 7ac6108

File tree

2 files changed

+19
-24
lines changed

2 files changed

+19
-24
lines changed

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,6 @@
2222

2323
## Overview
2424

25-
Mutation testing is used by big tech companies like [Google](https://research.google/pubs/state-of-mutation-testing-at-google/) to ensure the robustness of their test suites. With Mutahunter, we aim to empower other companies and developers to use this powerful tool to enhance their test suites and improve software quality.
26-
27-
Mutation testing verifies the effectiveness of your test cases by creating small changes, or “mutants,” in the code and checking if the test cases can catch these changes. Unlike line coverage, which only shows code execution, mutation testing reveals how well the code is tested.
28-
2925
Mutahunter uses LLM models to inject context-aware faults into your codebase. This AI-driven approach produces fewer equivalent mutants, mutants with higher fault detection potential, and those with higher coupling and semantic similarity to real faults, ensuring comprehensive and effective testing.
3026

3127
## Features
@@ -42,15 +38,15 @@ Mutahunter uses LLM models to inject context-aware faults into your codebase. Th
4238

4339
1. **Achieve High Line Coverage:** Ensure your test suite has high line coverage, preferably 100%.
4440

45-
2. **Strict Mutation Testing:** Use strict mutation testing to improve mutation coverage during development without additional cost. Utilize the `--only-mutate-file-paths` flag for targeted testing on critical files.
41+
2. **Strict Mutation Testing:** Use strict mutation testing during development to improve mutation coverage during development without additional cost. Utilize the `--only-mutate-file-paths` flag for targeted testing on critical files.
4642

4743
3. **LLM-Based Mutation Testing on Changed Files:** Inject context-aware mutants using LLMs on changed files during pull requests as the final line of defense. Use the `--modified-files-only` flag to focus on recent changes. In this way it will make the mutation testing significantly **faster** and **cost effective.**
4844

4945
## Getting Started
5046

5147
```bash
5248
# Install Mutahunter package via GitHub. Python 3.11+ is required.
53-
$ pip install git+https://github.com/codeintegrity-ai/mutahunter.git
49+
$ pip install muthaunter
5450

5551
# Work with GPT-4o on your repo
5652
$ export OPENAI_API_KEY=your-key-goes-here
@@ -135,7 +131,7 @@ jobs:
135131
python-version: 3.11
136132
137133
- name: Install Mutahunter
138-
run: pip install git+https://github.com/codeintegrity-ai/mutahunter.git
134+
run: pip install mutahunter
139135
140136
- name: Set up Java for your project
141137
uses: actions/setup-java@v2

pyproject.toml

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,33 @@
11
[build-system]
2-
requires = ["setuptools", "wheel"]
2+
requires = ["setuptools"]
33
build-backend = "setuptools.build_meta"
44

5-
6-
[tool.distutils.bdist_wheel]
7-
universal = true
8-
9-
105
[project]
116
name = 'mutahunter'
12-
description = "LLM Language Agnostic Mutation Testing"
7+
description = "LLM Mutation Testing for any programming language"
138
requires-python = ">= 3.11"
149
version = "1.0.0"
1510
dependencies = [
1611
"tree-sitter==0.21.3",
1712
'tree_sitter_languages==1.10.2',
18-
"tiktoken",
1913
"tqdm",
20-
'diff-match-patch',
2114
'grep_ast',
22-
'pygments',
23-
'networkx',
24-
'numpy',
25-
'scipy',
26-
'setuptools',
27-
'jinja2',
28-
'litellm',
15+
'pygments==2.18.0',
16+
'networkx==3.3',
17+
'jinja2==3.1.4',
18+
'litellm==1.41.21',
19+
"numpy==2.0.0",
20+
"scipy==1.14.0",
2921
]
30-
22+
keywords = ["mutahunter", 'test', "testing", "LLM", 'mutant']
23+
readme = "README.md"
24+
license = { file = "LICENSE" }
3125
authors = [{ name = "Steven Jung" }]
26+
maintainers = [{ name = "Steven Jung" }]
27+
28+
[project.urls]
29+
Homepage = "https://www.mutahunter.ai"
30+
Repository = "https://github.com/codeintegrity-ai/mutahunter"
3231

3332
[project.optional-dependencies]
3433
dev = ['isort', 'black']

0 commit comments

Comments
 (0)