Financier

Model compensation packages with python. Can be useful to compare job offers.

HOOLI = Offer(
    'Hooli',
    [Salary(yearly_amount=15000),
    StockGrant(
        amount=10000,
        schedule=FourYearsScheduleOneYearCliff(
            grant_date=datetime.date(2017, 2, 25)
        )
    ),
    OneTimeBonus(amount=10000,
                 payoff_date=datetime.date(2019, 3, 5)),
    Match401k(yearly_income=15_0000,
              match_percentage=0.03,
              match_contribution_per_dollar=0.5)],
)

plot_income(
    Calculator.cummulative_income(
        offer = HOOLI,
        date_range=four_years_by_month()
    ), "/tmp/hooli.png"
)

Installation

Installing with pip

This package is not yet published via pypi.

Manual installation from git

Clone the repo and set up a virtualenv:

git clone [email protected]:charignon/financier
cd financier
pip3 install poetry
poetry install

Run the example:

poetry run examples/example1.py

Usage

See my blog post for more information.

Contributing

Running the tests

poetry run py.test

Origin of the name financier

It is a french adjective that means "related to finance".