Metadata-Version: 2.1
Name: exchange-rate-alert
Version: 0.2
Summary: Create desktop alerts for Transferwise exchange rates
Home-page: https://github.com/paradigmwit/exchange-rate-alert
Author: Fahd Mohammed Khan
Author-email: fahd_khan_01@hotmail.com
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: requests
Requires-Dist: pypiwin32
Requires-Dist: setuptools
Requires-Dist: win10toast

# Exchange Rate Alert
---

Creates desktop alerts for Transferwise exchange rates at specified intervals.

---

#### Before Using

Before the module can be used the user has to create a Transferwise API token. The detailed instructions can be found here - https://api-docs.transferwise.com/#payouts-guide-api-access  

The program will try and find the access token in the following manner

 1. System Variable named TCR - create a system variable named TCR

 2. Configuration file - located at `%HOMEDRIVE%%HOMEPATH%/.tcr` on windows or `~/.tcr` on linux

---

#### Usage 

Install package from pip 
- `pip install exchange-rate-alert`


Import into python script
- `from ratealert.conversionalert import ConversionAlert`

Call the constructor, wait for alert, profit!
- `ConversionAlert(source, target, interval)`

--- 

#### Example

`from ratealert.conversionalert import ConversionAlert`

`ConversionAlert('SEK', 'INR', 300)`

This will create exchange rate alerts every 5 minutes. 

---

#### Next steps

- Alert on a target conversion rate
- Quotation request on target conversion rate



