Metadata-Version: 2.2
Name: grim-reaper-core
Version: 0.1.0
Summary: High-performance mathematical library.
Author: Eduardo Amorim Pereira
License: MIT
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# `grim-reaper.py`

`grim-reaper.py`, or just Grim, is a Python math library made in C++ made for solving fast operations such as adding, subtracting, multiplying and dividing.

## Installation

### Using GitHub

#### Clone the project and enter on the directory

In HTTPS:

```bash 
git clone https://github.com/eduardozitinho/grim-reaper.py.git
cd grim-reaper.py
```

In GitHub CLI:

```bash
gh repo clone eduardozitinho/grim-reaper.py
cd grim-reaper.py
```

#### Guarantee you got Python installed

##### Linux

###### Ubuntu, Debian

```bash
sudo apt install python3 # don't use sudo incase you're already root
```

###### Arch

```bash 
sudo pacman -S python python-pip python-setuptools
```

If your Linux distro isn't any of those listed, see [official Python website](https://www.python.org)

##### Windows, MacOS

Since I, the author, never installed Python in MacOS or Windows (never had one though), I don't know anything about installing Python in any. See [official Python website](https://www.python.org) for an install guide for them.

##### Android

This is my operating system!

First, go to [F-Droid](https://f-droid.org).

Search for Termux app and install it. Make sure its version is stable and not `beta`.

After that, enter in Termux and run the following commands:

```bash
pkg upgrade -y
pkg update -y
pkg install python -y # The -y in everything auto confirms it
```

Boom! You have Python installed in Android.


#### Installing the package with pip

Make sure you are inside `grim-reaper.py`.

```bash
python -m pip install .
```

Now you can use it everywhere!

### Using pip (future)

If you already have Python installed, you skipped most of the steps. Now run this:

```bash
python -m pip install grim_reaper
```

That's future, since this isn't released yet.

## Usage

After installing the package, you can use like this:

```python
import grim_reaper

# Add any amount of numbers, including sets, lists, tuples

grim_reaper.basic_ops.add(10, 20, 30, 40, [50, 60], {70, 80}, 90, 100)

# Subtract any amount of numbers, including sets, lists, tuples

grim_reaper.basic_ops.sub(20, 10, 1, 1, 1, 1, 1, 1, -1, [1, 1], {10, 5}, (10, 10))

# Multiply any amount of numbers, including sets, lists, tuples

grim_reaper.basic_ops.mul(10, {5, 2}, [1, 10], (3, 3))

# Divide any amount of numbers, including sets, lists, tuples and handles division by zero (ValueError)

grim_reaper.basic_ops.div(10, 1, 2, (2, 2), [4, 1], {8, 9})
```

Those are the four-first functions of Grim.

## License

The current license of the project is MIT. See complete license [here](LICENSE).
