Metadata-Version: 2.1
Name: primeTester
Version: 1.0
Summary: A collection of Python modules consisting different primality tests.
Home-page: https://github.com/avrha/Prime-Tests
Author: Joey Ferenchak
Author-email: sjferenchak@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# PrimeTester
Prime-Tests is a collection of Python modules consisting different [primality tests](https://en.wikipedia.org/wiki/Primality_test).

## Tests Included 
- Fermat Test
- Miller Rabin Test
- Solovay Strassen
- AKS Test
- Trial Division

## Install
``
pip3 install PrimeTester
``

## Usage
Import the test function from the python modules installed. 

``
from aks import aks
``

For probability based tests (Fermat, Miller Rabin, Solovay Strassen) those functions take in two arguments.
The first argument takes in a number to be tested as prime, the second is the number of test iterations. 

``
print(fermat(5,100))
``

All the test functions will return a true or false value. A returned true value indicates that the inputted number is a prime. A returned false value indicates that the inputted number is not a prime. 



