portfolio_toolkit.position package

Subpackages

• portfolio_toolkit.position.closed package
  • Submodules
    • portfolio_toolkit.position.closed.closed_position module
      • ClosedPosition
    • portfolio_toolkit.position.closed.closed_position_list module
      • ClosedPositionList
    • portfolio_toolkit.position.closed.get_closed_positions_stats module
      • get_closed_positions_stats()
      • print_closed_positions_summary()
    • portfolio_toolkit.position.closed.list_from_portfolio module
      • get_closed_positions()
      • get_asset_closed_positions()
    • portfolio_toolkit.position.closed.plot_closed_positions module
      • plot_closed_positions()
      • plot_closed_positions_by_ticker()
      • plot_closed_positions_count_by_month()
  • Module contents
    • ClosedPosition
      • ClosedPosition.__init__()
      • ClosedPosition.to_dataframe()
      • ClosedPosition.to_list()
      • ClosedPosition.buy_date
      • ClosedPosition.sell_price
      • ClosedPosition.sell_date
      • ClosedPosition.value
      • ClosedPosition.profit
      • ClosedPosition.return_percentage
      • ClosedPosition.ticker
      • ClosedPosition.buy_price
      • ClosedPosition.quantity
      • ClosedPosition.cost
    • ClosedPositionList
      • ClosedPositionList.__init__()
      • ClosedPositionList.from_portfolio()
      • ClosedPositionList.get_stats()
      • ClosedPositionList.to_dataframe()
      • ClosedPositionList.to_list()
• portfolio_toolkit.position.open package
  • Submodules
    • portfolio_toolkit.position.open.list_from_portfolio module
      • get_open_positions()
      • get_asset_open_positions()
    • portfolio_toolkit.position.open.open_position module
      • OpenPosition
    • portfolio_toolkit.position.open.open_position_list module
      • OpenPositionList
    • portfolio_toolkit.position.open.pie_chart_data module
      • get_pie_chart_data()
  • Module contents
    • OpenPosition
      • OpenPosition.__init__()
      • OpenPosition.to_dataframe()
      • OpenPosition.to_list()
      • OpenPosition.current_price
      • OpenPosition.sector
      • OpenPosition.country
      • OpenPosition.value
      • OpenPosition.ticker
      • OpenPosition.buy_price
      • OpenPosition.quantity
      • OpenPosition.cost
    • OpenPositionList
      • OpenPositionList.__init__()
      • OpenPositionList.from_portfolio()
      • OpenPositionList.get_pie_chart_data()
      • OpenPositionList.to_dataframe()
      • OpenPositionList.to_list()

Submodules

• portfolio_toolkit.position.compare_open_positions module
  • compare_open_positions()
• portfolio_toolkit.position.position module
  • Position
    • Position.ticker
    • Position.buy_price
    • Position.quantity
    • Position.cost
    • Position.to_list()
    • Position.to_dataframe()
    • Position.__init__()

Module contents

class portfolio_toolkit.position.Position(ticker: str, buy_price: float, quantity: float)

Bases: object

__init__(ticker: str, buy_price: float, quantity: float) → None

classmethod to_dataframe(positions: List[Position]) → DataFrame

Convert a list of Position objects to a pandas DataFrame.

classmethod to_list(positions: List[Position]) → List[dict]

Convert a list of Position objects to a list of dictionaries.

ticker: str

buy_price: float

quantity: float

cost: float

class portfolio_toolkit.position.OpenPosition(ticker: str, buy_price: float, quantity: float, current_price: float, sector: str, country: str)

Bases: Position

__init__(ticker: str, buy_price: float, quantity: float, current_price: float, sector: str, country: str) → None

classmethod to_dataframe(positions: List[OpenPosition]) → DataFrame

Convert a list of Position objects to a pandas DataFrame.

classmethod to_list(positions: List[OpenPosition]) → List[dict]

Convert a list of Position objects to a list of dictionaries.

current_price: float

sector: str

country: str

value: float

class portfolio_toolkit.position.ClosedPosition(ticker: str, buy_price: float, quantity: float, buy_date: str, sell_price: float, sell_date: str)

Bases: Position

__init__(ticker: str, buy_price: float, quantity: float, buy_date: str, sell_price: float, sell_date: str) → None

classmethod to_dataframe(positions: List[ClosedPosition]) → DataFrame

Convert a list of Position objects to a pandas DataFrame.

classmethod to_list(positions: List[ClosedPosition]) → List

Convert a list of Position objects to a pandas DataFrame.

buy_date: str

sell_price: float

sell_date: str

value: float

profit: float

return_percentage: float

portfolio_toolkit.position.compare_open_positions(portfolio: Portfolio, periods: List[Period], display='value') → DataFrame

Compare open positions across multiple periods.

Creates a DataFrame showing position values or returns at the end of each period. Rows represent assets, columns represent periods.

Parameters:

• portfolio – Portfolio object containing assets

• periods – List of Period objects to compare

• display – ‘value’ shows position values, ‘return’ shows percentage returns

Returns:

DataFrame with assets as rows and periods as columns.

For ‘value’: Values show position market value, “-” for missing positions. For ‘return’: Values show percentage return vs previous period, “-” for missing/first period.

Return type:

pd.DataFrame

Example

# Show values df = compare_open_positions(portfolio, periods, display=’value’) Result:

Q1 2025 Q2 2025

AAPL 1500.00 1650.00 GOOGL 2000.00 -

# Show returns df = compare_open_positions(portfolio, periods, display=’return’) Result:

Q1 2025 Q2 2025

AAPL - 10.00% GOOGL - -