https://github.com/joachimhodana/fairprice

Python module to balance prices with use of various strategies
https://github.com/joachimhodana/fairprice

balance contributions-welcome module price price-balance pypi python

Last synced: 3 months ago
JSON representation

Python module to balance prices with use of various strategies

• Host: GitHub
• URL: https://github.com/joachimhodana/fairprice
• Owner: joachimhodana
• License: mit
• Created: 2023-11-05T03:01:58.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-11-15T14:09:57.000Z (almost 2 years ago)
• Last Synced: 2025-06-08T18:05:59.804Z (4 months ago)
• Topics: balance, contributions-welcome, module, price, price-balance, pypi, python
• Language: Python
• Homepage: https://pypi.org/project/fairprice
• Size: 188 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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 fair 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 ()

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