A powerful command-line tool that uses the openness of Portfolio Performance data and the convenient access of ppxml2db to offer a whole new level of insights into your portfolio.
For example, pp-terminal includes a command to calculate the preliminary tax values ("Vorabpauschale") for Germany:
pp-terminal is a lightweight tool for all the nice-to-have features that won't make it into the official Portfolio Performance app. This can be because of country-dependant tax rules, complex Java implementation, highly individual requirements, too many edge-cases, etc.
Important
I am not a tax consultant. All results of this application are just a non-binding indication and without guarantee. They may deviate from the actual values.
Tip
Using MoneyMoney for managing your finances? Check out my Sankey Charts Extension.
Code completion for commands and options is available.
You can choose between different output formats like JSON or CSV with the --format option.
In addition to the standard set, you can easily create your own commands and share them with the community.
By default, pp-terminal --help provides the following commands:
| Command | Description |
|---|---|
view accounts |
Get detailed information about the balances per each deposit and/or securities account |
view securities |
Get detailed information about the securities |
The commands can be customized in the configuration file:
[commands.view.accounts]
columns = ["AccountId", "Name", "Balance"] # call with --columns=xx to see a list of all available columns
[commands.view.securities]
columns = ["SecurityId", "Name", "Shares"]| Command | Description |
|---|---|
simulate interest |
Calculate how much interest you should have been earned per account and compare with actual values |
simulate share-sell |
Calculate gains and taxes if a security would be sold in future (based on FIFO capital gains) |
simulate vap |
Run a simulation for the expected German preliminary tax ("Vorabpauschale") on the portfolio |
The tax configuration for the simulations can be customized in the configuration file:
[tax]
rate = 26.375 # percentage
# Optionally define the already paid taxes per share (e.g. for the share-sell command)
file = "taxes_paid.csv" # Format: date;account_id;security_id;tax_per_share
exemption-rate = 30 # percentage
exemption-rate-attribute = "b3c38686-2d22-4b5d-8e38-e61dcf6fdde3" # for per-security exemption rates | Command | Description |
|---|---|
validate |
Run all validation checks on the portfolio data |
validate accounts |
Run configured accounts validations, e.g. balance limits |
validate securities |
Run configured security validations, e.g. prices up-to-date |
This is a sample of validation rules that can be configured in the configuration file:
# Note: the rules are processed in this order, each rule type only triggers once for each entity
# Validate a certain bank account does not have more than a certain custody fee threshold
[[commands.validate.accounts.rules]]
type = "balance-limit"
value = 25000
applies-to = ["c9c57e01-7ea0-4e70-bed9-4656941f7687"] # Portfolio Performance account id from the XML file
# Validate that each bank account is within the EU deposit insurance limit
[[commands.validate.accounts.rules]]
type = "balance-limit"
value = 100000
# Use date attributes in Portfolio Performance to validate against (e.g. when special interest rate offers end)
[[commands.validate.accounts.rules]]
type = "date-passed-from-attribute"
value = "fgdeb0dd-8bd7-47b1-ac3f-30fedd6a47e9" # Portfolio Performance date attribute id from the XML file
# Verify security prices are up-to-date
[[commands.validate.securities.rules]]
type = "price-staleness"
severy = "error" # default, can be omitted
value = 90
[[commands.validate.securities.rules]]
type = "price-staleness"
severity = "warning"
value = 30
# Validate current cost basis (FIFO) against limit, e.g. for exit taxation thresholds ("Wegzugsbesteuerung")
[[commands.validate.securities.rules]]
type = "purchase-cost-limit"
value = 500000.0
severity = "warning"| Command | Description |
|---|---|
export |
Save the Portfolio Performance XML file to a different location |
Use the --anonymize flag to export an anonymized version:
pp-terminal --file depot.xml --anonymize export --output-file anonymized.xmlAnonymization can be customized in the configuration file:
[anonymization.attributes."a1b2c3d4-e5f6-7890-abcd-ef1234567890"]
provider = "iban" # for all available providers see https://faker.readthedocs.io/en/master/providers.html
[anonymization.attributes."fgdeb0dd-8bd7-47b1-ac3f-30fedd6a47e9"]
provider = "pyfloat"
args = { min_value = 0.0, max_value = 1.0, right_digits = 2 }- pipx to install the application (without having to worry about different Python runtimes)
- Portfolio Performance version >= 0.70.3
- Portfolio Performance file must be saved as "XML with id attributes"
pipx install pp-terminal
Once installed, update to the latest with:
pipx upgrade pp-terminal
Tip
The application does not modify the original Portfolio Performance file and works completely offline.
All commands require the Portfolio Performance XML file as input.
You can either provide that file as first option to the command
pp-terminal --file=depot.xml view accounts
or use a configuration file (see below).
To view all available arguments you can always use the --help option.
To persist the CLI options you can pass a configuration file in TOML format with pp-terminal --config=config.toml --help.
The CLI options always overwrite the settings in the configuration file.
file = "portfolio_performance.xml"
precision = 4If you want another formatting for numbers, assure that the terminal has the correct language settings, e.g. for Germany
set environment variable LANG=de_DE.UTF-8.
To disable all colors in the console output for a better readability, you can set the NO_COLOR=1 environment variable.
To contribute improvements to pp-terminal just follow these steps:
- Fork and clone this repository
- Run
make - Verify build with
poetry run pp-terminal --version - Create a new branch based on
master:git checkout master && git pull && git checkout -b your-patch - Implement your changes in this new branch
- Run
maketo verify everything is fine - Submit a Pull Request
Developers can easily extend the default pp-terminal functionality by implementing their own commands. Therefore, the Python
entry point pp_terminal.commands is provided.
To hook into a sub-command, e.g. view, you have to prefix the entry point name with view..
The most basic pp-terminal command looks like this:
from pp_terminal.output import Console
import typer
app = typer.Typer()
console = Console()
@app.command
def hello_world() -> None:
console.print("Hello World")This will result in the command pp-terminal hello-world being available.
For more sophisticated samples take a look at the packaged commands in the pp_terminal/commands directory,
e.g. a good starting point is view_accounts.py.
The commands must be grouped by action, e.g. view accounts or simulate share-sell.
The app uses Typer for composing the commands and Rich for nice console outputs. The Portfolio Performance XML file is read with ppxml2db and efficiently held in pandas dataframes.
If your command makes sense for a broader audience, I'm happy to accept a pull request.
[!INFO] The script is still in beta version, so there might be Portfolio Performance files that are not compatible with and also public APIs can change.
In case you are experiencing any problems:
- Create an anonymized version of your portfolio with
pp-terminal --file depot.xml --anonymize export --output-file anonymized.xml(verify!) - Add the
--verboseoption to the command that is causing the issue - And submit a new issue and include the results from steps 1. and 2.
This project is licensed under the GNU General Public License v3.0 (GPL-3.0). See the LICENSE file for more details.