Metadata-Version: 2.4
Name: currency-symbols
Version: 2.0.6
Summary: Get currency symbol by currency code
Author-email: Arshad Kazmi <arshadkazmi42@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/arshadkazmi42/currency-symbols
Project-URL: Repository, https://github.com/arshadkazmi42/currency-symbols
Project-URL: Issues, https://github.com/arshadkazmi42/currency-symbols/issues
Keywords: currency,currency-symbols,iso-4217,currency-code,symbols
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Libraries
Classifier: Typing :: Typed
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# currency-symbols :money_with_wings:

[![CI](https://github.com/arshadkazmi42/currency-symbols/actions/workflows/pytest.yml/badge.svg)](https://github.com/arshadkazmi42/currency-symbols/actions/workflows/pytest.yml)
[![Version](https://img.shields.io/pypi/v/currency-symbols.svg)](https://pypi.org/project/currency-symbols/)
[![Downloads](https://img.shields.io/pypi/dm/currency-symbols.svg)](https://pypi.org/project/currency-symbols/)
[![LICENSE](https://img.shields.io/pypi/l/currency-symbols.svg)](https://github.com/arshadkazmi42/currency-symbols/blob/master/LICENSE)

Get the currency symbol for an [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) currency code — `USD → $`, `EUR → €`, `INR → ₹`.

- Covers all active ISO 4217 codes, plus common historical, crypto and commodity codes
- Zero dependencies
- Fully typed ([PEP 561](https://peps.python.org/pep-0561/), ships `py.typed`)
- Python 3.9+

## Installation

```console
pip install currency-symbols
```

## Usage

```python
from currency_symbols import CurrencySymbols

CurrencySymbols.get_symbol("USD")
# '$'

CurrencySymbols.get_symbol("EUR")
# '€'

CurrencySymbols.get_symbol("gbp")
# '£' — codes are case-insensitive

CurrencySymbols.get_symbol("XYZ")
# None — unknown codes return None
```

## Changelog

All notable changes are documented in the [CHANGELOG](https://github.com/arshadkazmi42/currency-symbols/blob/master/CHANGELOG.md).

## Contributing

Interested in contributing to this project?
You can log any issues or suggestions related to this library [here](https://github.com/arshadkazmi42/currency-symbols/issues/new)

Read our contributing [guide](https://github.com/arshadkazmi42/currency-symbols/blob/master/CONTRIBUTING.md) on getting started with contributing to the codebase

## Credits

Inspired by work of [@bengourley](https://github.com/bengourley) on [currency-symbol-map](https://github.com/bengourley/currency-symbol-map#readme)

## License

[MIT](https://github.com/arshadkazmi42/currency-symbols/blob/master/LICENSE)
