-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #12 from WiredNerd/docs
📓 doc updates
- Loading branch information
Showing
11 changed files
with
1,767 additions
and
283 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| # Credits | ||
|
|
||
| ```text | ||
| _=,_ | ||
| o_/6 /#\ | ||
| "You're not a Dog!" \__ |##/ | ||
| --.__.-- ='|--\ | ||
| ___\(0_0)/ / #'-. | ||
| ~~/ (OO) "My name is Dog." \#|_ _'-. / | ||
| \ __ / |/ \_( # |" | ||
| `='`='= C/ ,--___/ | ||
| ``` | ||
|
|
||
| ## ASCII Art | ||
|
|
||
| * [Text to ASCII Art Generator (TAAG) - patorjk.com](https://patorjk.com/software/taag/) | ||
| * [ASCII Art Archive](https://www.asciiart.eu/) | ||
|
|
||
| ## Inspiration | ||
|
|
||
| When I was looking for a Python Mutation Testing tool, the top candidates I found were [Mutmut](https://mutmut.readthedocs.io) and [Mutatest](https://mutatest.readthedocs.io/). Both are good tools with pros and cons of each. I decided to create my own tool because I wanted a more configurable tool, that is able to run multiple trials in parallel. I considered submitting updates to one or the other, but found that what I wanted would be nearly a rewrite. By starting over new, I was able to utilize new tools, some that weren't part of python's base till version 3.9. | ||
|
|
||
| ## Tools | ||
|
|
||
| :::{list-table} | ||
| :header-rows: 1 | ||
| :align: left | ||
|
|
||
| * - Tool | ||
| - Description | ||
| * - [click](https://click.palletsprojects.com/) | ||
| - Click is a Python package for creating beautiful command line interfaces in a composable way with as little code as necessary. | ||
| * - [wcmatch](https://facelessuser.github.io/wcmatch/) | ||
| - Wildcard Match provides an enhanced fnmatch, glob, and pathlib library in order to provide file matching and globbing that more closely follows the features found in Bash | ||
| * - [pytest](https://docs.pytest.org/) | ||
| - The pytest framework makes it easy to write small, readable tests, and can scale to support complex functional testing for applications and libraries | ||
| * - [pytest-cov](https://pytest-cov.readthedocs.io/) | ||
| - This plugin produces coverage reports. | ||
| * - [pytest-sort](https://pytest-sort.readthedocs.io/) | ||
| - This Pytest plugin is used to help identify Application State Leaks in your test suite. | ||
| * - [isort](https://pycqa.github.io/isort/) | ||
| - isort your imports, so you don't have to. | ||
| * - [black](https://black.readthedocs.io/) | ||
| - The uncompromising code formatter. | ||
| * - [ruff](https://docs.astral.sh/ruff/) | ||
| - An extremely fast Python linter and code formatter, written in Rust. | ||
| * - [mypy](https://mypy.readthedocs.io/) | ||
| - Mypy is a static type checker for Python. | ||
| * - [sphinx](https://www.sphinx-doc.org/) | ||
| - Sphinx makes it easy to create intelligent and beautiful documentation. | ||
| * - [furo](https://pradyunsg.me/furo/) | ||
| - A clean customizable Sphinx documentation theme. | ||
| * - [myst_parser](https://myst-parser.readthedocs.io/) | ||
| - A Sphinx and Docutils extension to parse MyST Markdown. | ||
| * - [sphinx_design](https://sphinx-design.readthedocs.io/) | ||
| - A sphinx extension for designing beautiful, screen-size responsive web-components. | ||
| ::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,17 @@ | ||
| # Mutation Testing | ||
|
|
||
| what is mutation testing | ||
| ```text | ||
| .-. | ||
| (___________________________________________________________()6 `-, | ||
| ( ______________________________________________________ /''"` | ||
| //\\ //\\ | ||
| "" "" "" "" | ||
| ``` | ||
|
|
||
| example of why | ||
| Coming Soon :safety_vest: | ||
|
|
||
| ## What is Mutation Testing? | ||
|
|
||
| ## Why Mutation Test? | ||
|
|
||
| ## Why Poodle? |
Oops, something went wrong.