Getting Started

IMPORTANT DISCLAIMER

portfolio-plan supports download of Yahoo! Finance data with the help of yfinance package. Please note the following important information:

• Yahoo!, Y!Finance, and Yahoo! finance are registered trademarks of Yahoo, Inc.

• This software is not affiliated, endorsed, or vetted by Yahoo, Inc.

• Users are responsible for ensuring their usage complies with Yahoo’s Terms of Service.

• portfolio-plan features that interface with yfinance are intended for personal, non-commercial use

Yahoo’s Terms of Service can be found at:

• API Terms

• General Terms

• Overall Terms

The maintainers of portfolio-plan are not responsible for any violations of Yahoo’s Terms of Service by end users.

Installation

pip install portfolio-plan

Documentation

Documentation is available here: https://sondalex.github.io/portfolio-plan/

Development

Install uv

pip install uv

Install pre-commit hooks

uv tool run pre-commit install

Running pre-commit hooks

uv tool run pre-commit run --all-files

Running the test suite:

uv run --active -m pytest

Building

uv build

Building the documentation

Installing the documentation dependencies

uv sync --active --only-dev

Generating the documentation:

cd docs/ && uv run --active make html