# CurrencyConverter - Python Package for Exchange Rates
This Python package provides a `CurrencyConverter` class to retrieve exchange rates and convert amounts between different currencies.
## Features:
- Fetches live exchange rates from a reputable API.
- Converts currency amounts based on retrieved rates.
- Handles errors for invalid API responses and missing currencies.
## Installation:
Install the package using pip:
```bash
pip install ks-currency-converter
```
## Usage:
Import the CurrencyConverter class:
```bash
import ks_currency_converter
```
## Create an instance of CurrencyConverter with your API key (replace with your own):
```bash
converter = ks_currency_converter.CurrencyConverter("YOUR_API_KEY")
```
Obtain a free API key from the currency exchange API provider {ExchangeRate-API}.
## Get the exchange rate for a specific currency pair:
```bash
usd_to_eur_rate = converter.get_exchange_rate("USD", "EUR")
print(f"1 USD is equal to {usd_to_eur_rate} EUR")
```
## Convert an amount between currencies:
```bash
amount_to_convert = 100
converted_amount = converter.convert(amount_to_convert, "USD", "JPY")
print(f"{amount_to_convert} USD is equal to {converted_amount} JPY")
```
## API Key:
You need a valid API key from a currency exchange API provider to use this package. The provided example key (5ea8fd42252121cf83a4738d) is for demonstration purposes only and may not be functional.
## Development and Testing:
This package offers basic functionality and error handling. Consider these points for further development:
## Implement caching for retrieved exchange rates.
Add unit tests to ensure code functionality.
## Contributing:
We welcome contributions to improve this package. Feel free to submit pull requests with enhancements or bug fixes.
Change Log
============
0.0.1 (27/06/2024)
----------------------
- First Release
Raw data
{
"_id": null,
"home_page": null,
"name": "ks-currency-convertor",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "currency_convertor",
"author": "Kripa Sindhu",
"author_email": "sindhukripa007@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b3/7e/598682be176d9f8e7f96da3457e8023b962b892630370607f2c3de152d12/ks_currency_convertor-0.0.1.tar.gz",
"platform": null,
"description": "# CurrencyConverter - Python Package for Exchange Rates\n\nThis Python package provides a `CurrencyConverter` class to retrieve exchange rates and convert amounts between different currencies.\n\n## Features:\n\n- Fetches live exchange rates from a reputable API.\n- Converts currency amounts based on retrieved rates.\n- Handles errors for invalid API responses and missing currencies.\n\n## Installation:\n\nInstall the package using pip:\n\n```bash\npip install ks-currency-converter\n```\n## Usage:\n\nImport the CurrencyConverter class:\n\n```bash\nimport ks_currency_converter\n```\n\n## Create an instance of CurrencyConverter with your API key (replace with your own):\n```bash\nconverter = ks_currency_converter.CurrencyConverter(\"YOUR_API_KEY\")\n```\n\nObtain a free API key from the currency exchange API provider {ExchangeRate-API}.\n\n## Get the exchange rate for a specific currency pair:\n```bash\nusd_to_eur_rate = converter.get_exchange_rate(\"USD\", \"EUR\")\nprint(f\"1 USD is equal to {usd_to_eur_rate} EUR\")\n```\n## Convert an amount between currencies:\n```bash\namount_to_convert = 100\nconverted_amount = converter.convert(amount_to_convert, \"USD\", \"JPY\")\nprint(f\"{amount_to_convert} USD is equal to {converted_amount} JPY\")\n```\n\n## API Key:\nYou need a valid API key from a currency exchange API provider to use this package. The provided example key (5ea8fd42252121cf83a4738d) is for demonstration purposes only and may not be functional.\n\n## Development and Testing:\nThis package offers basic functionality and error handling. Consider these points for further development:\n\n## Implement caching for retrieved exchange rates.\nAdd unit tests to ensure code functionality.\n## Contributing:\nWe welcome contributions to improve this package. Feel free to submit pull requests with enhancements or bug fixes.\n\nChange Log\n============\n\n0.0.1 (27/06/2024)\n----------------------\n- First Release\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A very currency convertor",
"version": "0.0.1",
"project_urls": null,
"split_keywords": [
"currency_convertor"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b37e598682be176d9f8e7f96da3457e8023b962b892630370607f2c3de152d12",
"md5": "bebeb981a4f0cca45d9901e6bb98b84f",
"sha256": "ace0bc529a6469d48254b0342baabf086f58f5216bad7514693a695c0aaa2fc5"
},
"downloads": -1,
"filename": "ks_currency_convertor-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "bebeb981a4f0cca45d9901e6bb98b84f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3514,
"upload_time": "2024-06-27T08:43:52",
"upload_time_iso_8601": "2024-06-27T08:43:52.995649Z",
"url": "https://files.pythonhosted.org/packages/b3/7e/598682be176d9f8e7f96da3457e8023b962b892630370607f2c3de152d12/ks_currency_convertor-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-27 08:43:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "ks-currency-convertor"
}
JSON