fermut 0.3.0__py3-none-win_amd64.whl

fermut-0.3.0.dist-info/METADATA

@@ -0,0 +1,152 @@
+Metadata-Version: 2.4
+Name: fermut
+Version: 0.3.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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 :: Rust
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Software Development :: Quality Assurance
+License-File: LICENSE-MIT
+License-File: LICENSE-APACHE
+Summary: Rust-powered, ty-aware mutation testing for Python
+Keywords: mutation-testing,mutation,testing,python,rust,ty,pytest
+Home-Page: https://github.com/KovantAI/fermut
+Author: Kovant AB
+Maintainer: Kovant AB
+License-Expression: MIT OR Apache-2.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Issues, https://github.com/KovantAI/fermut/issues
+Project-URL: Repository, https://github.com/KovantAI/fermut
+
+# fermut
+
+Agent-first mutation testing for Python — built on
+[`ruff`](https://github.com/astral-sh/ruff) parsing and
+[`ty`](https://github.com/astral-sh/ty) type-awareness.
+
+**New to mutation testing?** Line and branch coverage tells you which
+lines your tests *execute*; mutation testing tells you which lines your
+tests *check*. fermut makes small changes to your source (a `<=` becomes
+`<`, a `+` becomes `-`), re-runs your tests, and reports which changes
+*survived* — those are the gaps your tests don't actually catch. In
+short: it answers "are my tests any good?"
+
+fermut is designed for coding agents in the loop: machine-readable JSON
+reports, deterministic mutant IDs, cache-friendly incremental runs, and
+exit codes that gate CI. Under the hood, it generates source-level
+mutants via [Astral's `ruff_python_parser`](https://github.com/astral-sh/ruff),
+drops type-invalid candidates with `ty` before they reach your test
+suite, and runs the survivors in parallel against `pytest` or
+`unittest`. Hot loop is native Rust; test runner stays Python. Humans
+welcome too.
+
+## Why fermut
+
+On **typer** (~2,200 mutants, cold run, same machine):
+
+| Tool   | Time  | Mutation score |
+|--------|-------|----------------|
+| fermut | 164s  | 71.5%          |
+| mutmut | 298s  | 70.5%          |
+
+fermut is **faster and higher-scoring** here — its `ty` pre-filter
+and per-test coverage selection cut wall-clock without dropping
+rigor. The win is suite-shaped: on tiny pure-Python libraries with
+fast full suites (e.g. more-itertools) mutmut's simpler model still
+wins. Full numbers, the repos where mutmut wins, and methodology:
+**[benchmarks](docs/reference/benchmarks.md)**.
+
+## Documentation
+
+**Full documentation lives at <https://fermut.readthedocs.io/>**, sourced
+from the [`docs/`](docs/) directory in this repo.
+
+Start here:
+
+- **[Coding agents](docs/guides/coding-agents.md)** — agent-driven inner
+  loop, cache strategy, JSON parsing recipes.
+- **[First steps](docs/getting-started/first-steps.md)** — `fermut init`
+  then `fermut run`, first report in under five minutes.
+- **[Installation](docs/getting-started/installation.md)** — prerequisites
+  and build paths.
+- **[Working on projects](docs/guides/projects.md)** — gradual rollout,
+  profile choice, CI integration.
+- **[CLI reference](docs/reference/cli/index.md)** — every subcommand,
+  every flag.
+- **[Configuration reference](docs/reference/configuration.md)** — every
+  `fermut.toml` key.
+- **[Operators](docs/reference/operators/index.md)** — the full mutation
+  operator catalogue.
+- **[Landscape](docs/concepts/landscape.md)** — vs `mutmut` and `cosmic-ray`.
+- **Migrating?** [from mutmut](docs/guides/migrate-from-mutmut.md) /
+  [from cosmic-ray](docs/guides/migrate-from-cosmic-ray.md) — or run
+  `fermut migrate {mutmut,cosmic-ray}` for one-shot translation.
+- **[Internals](docs/reference/internals/index.md)** + **[Adding an
+  operator](docs/reference/internals/adding-operators.md)** — contributor
+  onboarding.
+
+## Quickstart
+
+```sh
+# install — pick the path that matches you
+uv tool install fermut                                             # prebuilt wheel from PyPI, no Rust needed
+cargo install --git https://github.com/KovantAI/fermut --locked    # from source: needs Rust + ~2 min first compile
+
+# in your project (needs pytest, coverage, pytest-cov, ty on the same PATH — see Installation)
+fermut init                     # detect source/tests/runner, write fermut.toml
+
+# fermut init wires per-test coverage when pytest-cov is present;
+# generate it before the first run (skip if your config has no `coverage` key):
+pytest --cov=src --cov-context=test
+coverage json -o coverage.json --show-contexts
+
+fermut run src/ --tests tests/  # first mutation report (add -q to silence progress logs)
+```
+
+For a CI gate, generate the opinionated profile instead — diff-only +
+coverage + a narrow operator set, tuned to fail fast on pull requests:
+
+```sh
+fermut init --profile pr-gate   # writes a CI-shaped fermut.toml (needs git + coverage.json)
+```
+
+It scopes mutation to lines changed vs `main`, so run it inside a git
+checkout with that base available — see
+**[CI quickstart](docs/guides/ci-quickstart.md)**.
+
+> **Install paths.** Prebuilt wheels ship to PyPI, so
+> `uv tool install fermut` (or `pipx`/`pip install fermut`) is the
+> no-Rust path. The `cargo install --git` path (Rust required) builds
+> from source — for hacking on fermut or platforms without a prebuilt
+> wheel. Full prerequisites in
+> **[Installation](docs/getting-started/installation.md)**.
+
+Exit code is non-zero when any mutant survives — wire that into CI to
+gate on mutation score.
+
+## Status
+
+fermut is pre-1.0. The CLI, config schema, and JSON report shape may
+change between `0.MINOR` releases. See
+[`VERSIONING.md`](VERSIONING.md) for the full contract.
+
+## License
+
+Licensed under either of [Apache License, Version 2.0](LICENSE-APACHE)
+or [MIT license](LICENSE-MIT) at your option.
+
+Unless you explicitly state otherwise, any contribution intentionally
+submitted for inclusion in this crate by you, as defined in the
+Apache-2.0 license, shall be dual-licensed as above, without any
+additional terms or conditions.
+

fermut-0.3.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+fermut-0.3.0.data/scripts/fermut.exe,sha256=4x90zSl_0sGSnDZUQB11JkQBv24uEEQegJFch4JeA6Y,28630016
+fermut-0.3.0.dist-info/METADATA,sha256=M3ZEkmXGhMAMV4S_ea6hDAhanxLrDWILO2SKayomhT8,6598
+fermut-0.3.0.dist-info/WHEEL,sha256=8Aej0W0a6Cz6apA3IzJrTnxLRVLAt-w0Oh8SA3Con_c,94
+fermut-0.3.0.dist-info/licenses/LICENSE-APACHE,sha256=WUyB06zvYH2vNOlIhn3M606CLBIOcUNzSBUX5aeRmts,11378
+fermut-0.3.0.dist-info/licenses/LICENSE-MIT,sha256=jWl8VLAaSwldy0koppf4rz7SI3fDWBEuR96jIg1OkcQ,1087
+fermut-0.3.0.dist-info/sboms/fermut.cyclonedx.json,sha256=yEKQMEPU1PsxDQvNAw89PH8kY6IZjdc0gk_8vyDsIVU,350179
+fermut-0.3.0.dist-info/RECORD,,

fermut-0.3.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.15.0)
+Root-Is-Purelib: false
+Tag: py3-none-win_amd64

fermut-0.3.0.dist-info/licenses/LICENSE-APACHE

@@ -0,0 +1,199 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for describing the origin of the Work and
+      reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Support. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or support.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't forget to
+      include the file's brackets!)  The recommended boilerplate uses
+      a file extension of `.txt`.
+
+      Copyright 2026 Kovant AB
+
+      Licensed under the Apache License, Version 2.0 (the "License");
+      you may not use this file except in compliance with the License.
+      You may obtain a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+      Unless required by applicable law or agreed to in writing, software
+      distributed under the License is distributed on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any permissions or
+      conditions of any kind. See the License for the specific
+      language governing permissions and limitations under the License.

fermut-0.3.0.dist-info/licenses/LICENSE-MIT

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kovant AB
+
+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.