Metadata-Version: 2.1
Name: fairprice
Version: 0.1.2
Summary: Balance the price of your products
Home-page: https://github.com/Style77/fairprice
Author: Joachim Hodana
Author-email: stylek777@gmail.com
License: MIT
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: anyio==4.0.0
Requires-Dist: black==23.10.1
Requires-Dist: certifi==2023.7.22
Requires-Dist: click==8.1.7
Requires-Dist: colorama==0.4.6
Requires-Dist: flake8==6.1.0
Requires-Dist: h11==0.14.0
Requires-Dist: httpcore==1.0.1
Requires-Dist: httpx==0.25.1
Requires-Dist: idna==3.4
Requires-Dist: isort==5.12.0
Requires-Dist: mccabe==0.7.0
Requires-Dist: mypy==1.6.1
Requires-Dist: mypy-extensions==1.0.0
Requires-Dist: numpy==1.26.1
Requires-Dist: packaging==23.2
Requires-Dist: pandas==2.1.2
Requires-Dist: pandas-stubs==2.1.1.230928
Requires-Dist: pathspec==0.11.2
Requires-Dist: platformdirs==3.11.0
Requires-Dist: pycodestyle==2.11.1
Requires-Dist: pyflakes==3.1.0
Requires-Dist: python-dateutil==2.8.2
Requires-Dist: python-dotenv==1.0.0
Requires-Dist: pytz==2023.3.post1
Requires-Dist: six==1.16.0
Requires-Dist: sniffio==1.3.0
Requires-Dist: types-pytz==2023.3.1.1
Requires-Dist: types-setuptools==68.2.0.0
Requires-Dist: typing_extensions==4.8.0
Requires-Dist: tzdata==2023.3

# fairprice

> python module to balance prices

[![PyPI](https://img.shields.io/pypi/v/fairprice.svg)](https://pypi.org/project/fairprice/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Python module for balancing product prices. It takes USD price and uses various strategies of your choice to calculate the price in other currencies.

## Installation

Pip is required to install the module. If you don't have pip installed, you can follow the instructions [here](https://pip.pypa.io/en/stable/installing/).

```sh
pip install fairprice
```

## Usage example

```python
from fairprice import FairPrice
from fairprice.strategy import BigMac

fp = FairPrice(strategy=BigMac)
fp.calculate(10, "PLN")
```

## Development setup

Clone the repository and install the requirements.

```sh
git clone https://github.com/Style77/fairprice.git
cd fairprice
pip install -r requirements.txt
```

## Contributing

1. Fork it (<https://github.com/Style77/fairprice/fork>)
2. Create your feature branch (`git checkout -b feature/fooBar`)
3. Commit your changes (`git commit -am 'Add some fooBar'`)
4. Push to the branch (`git push origin feature/fooBar`)
5. Create a new pull request
