Metadata-Version: 2.1
Name: calculator_gskv_m1_s1
Version: 0.1.3
Summary: This module contains a Calculator
Author-email: Gediminas Skvarnavicius <gediminas.skvarnavicius@gmail.com>
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
Project-URL: Home, https://github.com/gediminas-skvarnavicius/calculator_gskv_m1_s1

# Calculator_gskv_m1_s1

Calculator_gskv_m1_s1 is a Python module for performing simple mathematical operations.

## Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install calculator_gskv_m1_s1.

```bash
pip install calculator_gskv_m1_s1
```

## Usage

```python
import calculator_gskv_m1_s1 as calc

# Initiates a calculator object with a default value of 0
calculator=calc.Calculator()

# Returns the current value of the calculator object
calculator.current_value

# Adds float or int argument to the current value and returns the result
calculator.add(float)

# Subtracts float or int argument from the current value and returns the result
calculator.subtract(float)

# Multiplies the current value by float or int argument and returns the result
calculator.multiply(float)

# Divides the current value by float or int argument and returns the result
calculator.divide(float)

# Raises the current value to the power of float or int argument and returns the result
calculator.exponentiate(float)

# Takes the root of the current value taking the float or int argument as root index
calculator.root(float)

# Resets the current value to zero returns current value
calculator.reset()
```

## Testing
After making changes to the module tests should be run.
Testing the package that is installed can be done by running [pytest](https://pypi.org/project/pytest-readme/)
```bash
pytest
```
Testing the package that is not installed can be done by invoking pytest trough the python interpreter
```bash
python -m pytest
```
## Contributors
Gediminas Skvarnavičius

With the help of Turing College
## License

[MIT](https://choosealicense.com/licenses/mit/)
