Metadata-Version: 2.1
Name: FxPy
Version: 1.1.5
Summary: ForexPy: A currency conversion tool that also scraps the web and gives the Forex Exchange rates from major services.
Home-page: https://www.github.com/navrajkalsi/forexpy
Author: Navraj Singh Kalsi
Author-email: navrajkalsi@icloud.com
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pycountry
Requires-Dist: requests
Requires-Dist: beautifulsoup4
Requires-Dist: keyboard
Requires-Dist: pandas
Requires-Dist: argparse
Requires-Dist: importlib.metadata

# ForexPy

A command-line tool for currency conversion that fetches live Forex exchange rates from popular exchange services using web scraping.

## Motivation

When sending money to another country, `how to choose which service to use?`
* You could google the conversion ,visit every site and compare the rates to find the best exchange rate

OR

* Use `ForexPy` and get rates from major services with a single command!

Personally, I was frustated whenever I needed to do a foreign transaction. If I choose one service due to its better rate next time the same service might be offering the worst rate. Therefore, I created ForexPy to save myself time, hassle and money.


## Quick Start

For `Windows`, try to use the terminal as an Administrator.

For `Linux`, this tool requires root access (because of usage of keyboard library). To run terminal as root, use the following command:

```bash
sudo su
# enter the password
```
![Linux Root Terminal Example](./media/1.png)

After gaining root or admin privileges continue with the following steps:

Install ForexPy using:
* __Pypi__

```bash
pip install fxpy
```

* __Git__

```bash
pip install git+https://github.com/navrajkalsi/forexpy.git
```

* __Clone the Repo__

```bash
git clone https://github.com/navrajkalsi/forexpy
cd forexpy
pip install .
```

## Usage

After Installation is complete, ForexPy can be used in the following ways:

* __With Arguments__: If you know the <a href="https://en.wikipedia.org/wiki/ISO_4217">ISO Alpha 3 Codes</a> of the currencies you want to convert, simply use the following command and pass the currency codes as arguments. The below example uses 'CAD' and 'INR'.

| Flag | Flag Description|
|:----:|:---------------:|
|-s| Sender Currency Code |
|-r| Receiver Currency Code |
|-v| Current Version of Tool |

```bash
# codes are case insensitive

fxpy --sender CAD --receiver INR
# or
fxpy -s cad -r inr
```

![CAD to INR Example Conversion](./media/1.gif)

* __Without Arguments__: If you do not know the exact currency codes, then you could just enter the following command and follow the instructions by entering in the respective country names (these names do not need to be perfect, the program will help in choosing the correct names).

```bash
fxpy
```

![CAD to INR Example Conversion](./media/2.gif)
