minigun-soren-n 0.3.8

A library for property-based testing of Python programs.

Notice

This project is WIP, but almost done!

• Implemtation
• Documentation
• Dependencies

Minigun

A QuickCheck-like library for property-based unit-testing of Python programs.

Minigun is inspired by QCheck, which in turn was inspired by QuickCheck. Both are libraries that provide implementations for performing property-based unit-testing; for OCaml and Haskell respectively.

If you would like a bit of motivation as to why you should use a QuickCheck-like system for testing your project, then I would recommend that you watch:

• John Hughes - Testing the Hard Stuff and Staying Sane
• John Hughes - Certifying your car with Erlang

If you wish to learn more about the subject, I can recommend Jan Midtgaard's lecture materials; it is OCaml based but translates easily to other QuickCheck-like libraries for other languages.

Install

Minigun is currently only supported for Python >=3.10, although it might work with older versions. It is distributed with pip and can be installed with the following example command:

$ python3 -m pip install minigun-soren-n

Documentation

A tutorial as well as reference documentation for the API can be found at Read The Docs.

Examples

The following projects use Minigun for testing:

• Minigun
• Tickle

If you have used Minigun for testing of a public project, and would like it added to the list, then please file an issue with a link to the project.