Skip to content

docs: improve README with precision explanation and acknowledgments #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
devAbreu merged 2 commits into from
May 27, 2025
Merged

docs: improve README with precision explanation and acknowledgments #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ea45683
docs: improve README with precision explanation and acknowledgments
devAbreu May 27, 2025
da495cc
Merge pull request #4 from devAbreu/docs/readme-improvements
devAbreu May 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

A lightweight, precise, and professional library for handling money in Python applications. `moneyx` solves **precision, rounding, and representation issues** that occur when using floating-point types like `float` for monetary calculations.

Unlike many Python money libraries, moneyx strictly enforces that all monetary amounts are represented with the correct number of decimal places for their currency. For example, 3.678 USD is automatically rejected as invalid (USD allows only 2 decimal places), as is 5.5 JPY (JPY allows 0 decimal places).

## 💰 Money Pattern

This library implements the Money Pattern as described by Martin Fowler in his book "Patterns of Enterprise Application Architecture" (2002). As Fowler notes:
Expand Down Expand Up @@ -268,6 +270,10 @@ Run benchmarks yourself with:
python -m pytest tests/test_benchmark.py --no-cov --benchmark-columns=Min,Max,Mean,Median,OPS
```

## 👏 Acknowledgments

This library was inspired by [py-money](https://github.com/vimeo/py-money) by Vimeo, while expanding functionality with additional features like multiple rounding strategies, allocation methods, and tax calculation utilities.

## 📖 License

MIT License - see [LICENSE](LICENSE) for details.