Metadata-Version: 2.1
Name: pyprobs
Version: 0.2
Summary: A module that returns True or False output based on given probability
Home-page: https://github.com/OmerFI/PyProbs
Author: Ömer Furkan İşleyen
Author-email: omergumushane@hotmail.com
License: MIT
Keywords: Probability,Chance
Platform: UNKNOWN
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown
License-File: LICENSE

# What is PyProbs?

PyProbs is a module that has useful functionality that returns True or False based on the given probability.

[![Version](https://img.shields.io/badge/Version-v0.2-orange)]()
[![Python](https://img.shields.io/badge/Python-v3.0%2B-blue)]()
[![License](https://img.shields.io/badge/License-MIT-green)]()


Examples
----------

Simple Usage:
```
>>> from PyProbs import Probability as pr
>>> # You can pass float (i.e. 0.5, 0.157), int (i.e. 1, 0) or str (i.e. '50%', '3/11')
>>> pr.Prob(50/100)
False
>>> pr.Prob(50/100, num=5)
[False, False, False, True, False]
```
Suggested and More Advanced Usage:
```
>>> from PyProbs import Probability as pr
>>> p = pr()
>>> p.iProb('3/7', 0.25, num=2)
[[True, True], [False, False]]

>>> p.history
{'3/7': [True, True], 0.25: [False, False]}
>>> p.count_values('all')
{True: 2, False: 2}

>>> p.set_constant(1/1000, mutable=True)  # If you set the mutable parameter to False, you won't be able to change the constant again.

>>> # You can get the constant and mutable value:
>>> p.get()
{'constant': 0.001, 'mutable': True}
>>> # Also you can use it like "p.get(how='constant')" or "p.get(how='mutable')", this only returns the desired value.

>>> p._constant # You can more easily get the constant value.
0.001
```

Functions of The Probability Class
----------
- Prob
- iProb
- set_constant
- get
- clear
- count_values

Note: All of them require creating an instance except the Prob function.

### Requirements

-   Python _v3.x_

### Documentation
https://pyprobs.readthedocs.io/

---------------------------------
### Any Bugs or Improvement Advice
Please contact me.
> omergumushane@hotmail.com


