Portfolio Finder Contributions API Reference¶

Portfolio Finder Contributions¶

Contains different approaches to make contributions to a portfolio each year.

class portfoliofinder.contributions.Contributions[source]¶

The contributions made to a portfolio for each year.

abstract get_contribution_for_year(year: int)[source]¶

Gets the contribution for the specified year.

Parameters: year – year relative to inception of portfolio (i.e., first year is 0)
Returns: contribution for the specified year

portfoliofinder.contributions.DEFAULT_CONTRIBUTION = <portfoliofinder.contributions.initial_contribution.InitialContribution object>¶: The default contribution option is simply a $10,000 initial investment.

class portfoliofinder.contributions.InitialContribution(starting_value: float)[source]¶

Bases: portfoliofinder.contributions.contributions.Contributions

A single contribution that is made to a portfolio at its inception.

Parameters: starting_value – initial contribution at inception of portfolio

get_contribution_for_year(year)[source]¶

Gets the contribution for the specified year.

Parameters: year – year relative to inception of portfolio (i.e., first year is 0)
Returns: contribution for the specified year

class portfoliofinder.contributions.RegularContributions(starting_value: float, annual_contribution: float)[source]¶

Bases: portfoliofinder.contributions.contributions.Contributions

An annual contributions are made to a portfolio.

Parameters

get_contribution_for_year(year: int)[source]¶

Gets the contribution for the specified year.

Parameters: year – year relative to inception of portfolio (i.e., first year is 0)
Returns: contribution for the specified year

class portfoliofinder.contributions.ScheduledContributions(scheduled_contributions: Dict[int, float])[source]¶

Bases: portfoliofinder.contributions.contributions.Contributions

Contributions which occur at specific years in the life of the portfolio.

Parameters: scheduled_contributions – contributions by year relative to inception of portfolio

get_contribution_for_year(year)[source]¶

Gets the contribution for the specified year.

Parameters: year – year relative to inception of portfolio (i.e., first year is 0)
Returns: contribution for the specified year