Metadata-Version: 2.5
Name: fyrefly
Version: 0.2.1
Summary: A quant based library to compute mathematical operations
Project-URL: Homepage, https://github.com/yourusername/fyrefly
Project-URL: Repository, https://github.com/yourusername/fyrefly
Author-email: Your Name <you@example.com>
License: MIT
License-File: LICENSE
Keywords: arithmetic,math,quant,utility
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.9
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == 'dev'
Description-Content-Type: text/markdown

# Fyrefly

A Quant based library to compute mathematical operations.

## Installation

```bash
pip install fyrefly
```

## Usage

```python
from fyrefly import add, mul, div, mod

add(5, 4, 6, 10)     # 25
mul(5, 4, 6, 10)     # 1200
div(100, 5, 2)       # 10.0
mod(17, 5)           # 2
```

Each function accepts any number of arguments:

```python
add(1)                # 1
add(1, 2, 3, 4, 5)    # 15
mul()                  # 1 (identity)
```

## Functions

| Function | Description |
|---|---|
| `add(*nos)` | Adds all given numbers |
| `mul(*nos)` | Multiplies all given numbers |
| `div(*nos)` | Divides left to right: first ÷ second ÷ third ... |
| `mod(*nos)` | Finds remainder left to right: first % second % third ... |

## Development

```bash
pip install -e ".[dev]"
pytest
```

## License

MIT