hledger-lots 0.1.3

No project description provided

Introduction

This script aims to help hledger's users to add transactions involving buying and selling commodities, which can be FOREX or investments assets, for example

When you sell a commodity, you should use the cost and quantity from the purchase date, which is buried deep down in your journal file so you have hledger accounting the correct Capital Gain.

You can choose between two diferrent methods to calculate the cost of selling lots:

• FIFO: First In First Out
• AVERAGE COST: Average Cost of all previous purchase. It is as if selling a proportional part of each previous sale.

This package create a sale transaction according to information provided by the user and traverse the journal file to determine what quantity and lot prices should be used and generate a valid hledger transaction to be appended to the journal with additional helpful calculations as comment tags.

When using this package, you don't need to create lots as subaccounts or tag, just add a purchase transaction as usual and when there is a sale, hledger-lots will generate the correct postings adding the cost for you, so you don't need to bother looking for this information.

It also generate lots reports so the user can understand his situation with a commodity and check the correctness of the generated sell transaction.

To verify your transaction, this package can also check if your past sale has the correct cost.

Documentation

Documentation with usage information can be found here

Requirements

• python
• hledger

Installation

pip install --upgrade hledger-lots

Workflow

1. Add purchase transaction as normal. Don't bother creating subaccounts or tags with unique lot name. See the some examples here
2. When you sell, use the command sell instead of adding the transactions manually. Hledger-fifo will generate the correct transaction and print to stdout so you can add to the journal if everything is correct. See transaction tags with interesting indicators about the current trade

By default the sale is created using FIFO method. Use the option flag "--avg-cost" to change it to Average Cost

Reports

To get information about the commodities, there is more 2 commands:

command	description
view	Get the lots and indicators for a specific commodity
list	Get the indicators for all commodities as a table

If you add price directives for the commodity in a date after the last purchase, additional indicators will be shown related to the performance of the investment. See indicators help for more detail.

Indicators

Basic Indicators

• Commodity Name
• Total Quantity Purchased
• Total Amount Purchased
• Average Cost

Market Indicators

For commodities with price directives on a date after the last purchase, you will have also the following indicators:

• Last Market Price
• Market Amount: Quantitty Purchased * Last Market Price
• Market Profit: Market Amount - Amount Purchased
• Last Market Date
• XIRR

XIRR

The sale transaction gives you the calculated xirr as tag, which is the internal rate of return of an investment based on a specified series of irregularly spaced cash flows. This value is annual percentage rate following the 30/360US day count convention. It is a good metric to compare the investment return with a benchmark like the S&P or the T-Bill, for example.

Note the benchmark can use another day count convention, so this comparison may not be 100% precise. This app may in the future offer others day count convention for xirr calculation.

Checks

It is recommended to use the option --check to ensure you past selling transaction has the correct cost according to the choosen cost method. It can be enabled by setting the environment variable HLEDGER_LOTS_CHECK to "true". It can be disabled with the option --no-check or setting the environment variable HLEDGER_LOTS_CHECK to "false".

At the moment the dafault is set to "false", but expect it to be turned to "true" in future releases.

Limitations

• No short-selling
• Each commodity can have only one base currency. For example, it is not possible to buy AAPL with USD and later with EUR.