Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
stared committed Jan 3, 2025
1 parent 50c283e commit 60fd26b
Showing 1 changed file with 18 additions and 11 deletions.
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Currex

A Pythonic currency calculator that makes working with currencies and exchange rates simple and intuitive.
A Pythonic currency calculator that makes working with currencies and exchange rates simple and smooth.

Works best in interactive python sessions (Jupyter Notebook, IPython, etc.).
I often use Python as a command-line calculator. Yet, I need to go back to Google Search to convert between curriencies. So, for my own convenience, I created this library.

IMPORTANT: It is inteded to be used in interactive sessions, not in production code.
It is inteded to be used interactive python sessions (such as Jupyter Notebook, IPython, etc.) to get ballpark estimates of prices - e.g. when travelling, buying online, etc.

EVEN MORE IMPORTANT: Never use it for any important decisions - taxes, investments, etc.
It is NOT intended to be used in production code. Every API design decision I made was to make it as simple as possible to use it in interactive sessions.

**EVEN MORE IMPORTANT**: Never use it for any important decisions - taxes, investments, etc. There is not quarantee that the exchange rates are correct.

## Installation

Expand All @@ -32,25 +34,30 @@ PLN(EUR(12)) # PLN(51.3312)

# add different currencies
USD(100) + EUR(100) # USD(203.50500)
EUR(100) + USD(100) # EUR(196.6100)
EUR(100) - USD(100) # EUR(2.60500)

# divide currencies
USD(2) / JPY(14) # 22.531428526365715
```

## Features

- Real-time exchange rates
- Intuitive Pythonic API
- Support for major world currencies
- Automatic currency conversion
- Type-safe operations
- Arithmetic operations with currencies
- Currency conversion
- Autocasting - when using a few currencies, automatically convert them to the first one

## Requirements

- Python 3.10 or higher
- Internet connection for real-time exchange rates - it uses [HexaRate](https://hexarate.paikama.co/)

## TODO

- More currencies
- Installation with PyPI
- Mock API for testing
- More backends for exchange rates

## License

MIT License
MIT License by [Piotr Migdał](https://p.migdal.pl/)

0 comments on commit 60fd26b

Please sign in to comment.