portfolio_toolkit.watchlist package

Submodules

portfolio_toolkit.watchlist.performance module

portfolio_toolkit.watchlist.performance.performance(assets: List[MarketAsset], periods: List[Period]) → DataFrame

Calculate performance comparison between periods for each asset.

Parameters:

assetsList[MarketAsset]

List of market assets with price data

periodsList[Period]

List of periods to compare

Returns:

pd.DataFrame

DataFrame where rows are assets (tickers) and columns are period labels. Each cell contains the percentage change from previous period to current period. First period column will contain “-” as there’s no previous period to compare.

portfolio_toolkit.watchlist.watchlist module

class portfolio_toolkit.watchlist.watchlist.Watchlist(name: str, currency: str, assets: List[MarketAsset], data_provider: DataProvider)

Bases: object

Class to represent and manage an asset watchlist.

name: str

currency: str

assets: List[MarketAsset]

data_provider: DataProvider

classmethod from_dict(data: dict, data_provider: DataProvider) → Watchlist

__init__(name: str, currency: str, assets: List[MarketAsset], data_provider: DataProvider) → None

portfolio_toolkit.watchlist.watchlist_from_dict module

portfolio_toolkit.watchlist.watchlist_from_dict.create_watchlist(data: dict, data_provider: DataProvider) → Watchlist

Loads and validates a JSON file containing watchlist information.

Parámetros:

• json_filepath (str) – Path to the JSON file to load data from.

• data_provider (DataProvider) – Data provider instance for fetching ticker information.

Devuelve:

An instance of the Watchlist class with loaded assets.

Tipo del valor devuelto:

Watchlist

Module contents

class portfolio_toolkit.watchlist.Watchlist(name: str, currency: str, assets: List[MarketAsset], data_provider: DataProvider)

Bases: object

Class to represent and manage an asset watchlist.

__init__(name: str, currency: str, assets: List[MarketAsset], data_provider: DataProvider) → None

classmethod from_dict(data: dict, data_provider: DataProvider) → Watchlist

name: str

currency: str

assets: List[MarketAsset]

data_provider: DataProvider