finance_rb

This package is a ruby native port of the numpy-financial package with some helpful additional functions.

The functions in this package are a scalar version of their vectorised counterparts in the numpy-financial library.

Currently, only some functions are ported,
which are as follows:

numpy-financial function	ruby native function ported?	info
fv	✅	Computes the future value
ipmt	✅	Computes interest payment for a loan
pmt	✅	Computes the fixed periodic payment(principal + interest) made against a loan amount
ppmt	✅	Computes principal payment for a loan
nper	✅	Computes the number of periodic payments
pv	✅	Computes the present value of a payment
rate	✅	Computes the rate of interest per period
irr	✅	Computes the internal rate of return
npv	✅	Computes the net present value of a series of cash flow
mirr	✅	Computes the modified internal rate of return

Things to be done:

1. Xirr
2. More specs for edge cases
3. Fee, currency protection and other cool stuff for advanced usage
4. Better errors

Installation

finance_rb is available as a gem, to install it just install the gem:

gem install finance_rb

If you're using Bundler, add the gem to Gemfile.

gem 'finance_rb'

Run bundle install.

Running tests

bundle exec rspec spec/

Contributing

1. Fork it ( https://github.com/wowinter13/finance_rb/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

License

MIT License. See LICENSE for details.