Skip to content

Latest commit

 

History

History
139 lines (117 loc) · 4.5 KB

README.md

File metadata and controls

139 lines (117 loc) · 4.5 KB

pycgt

A capital gain tax calculator for crypto traders or investors. This is just a toy script, not a mature product. Please notice following known limits of it:

  • cannot process raw logs from any exchanges, you need to transform your trading logs into pycgt's format before using it
  • limited currency types
    • supported cryptos: BTC, ETH, LTC, NMC
    • supported fiats: USD, AUD
  • limited trading pairs
    • supported pairs: btcusd, btcaud, ltcusd, nmcusd, xethxxbt, xethzusd, ethusd, xltczusd, xxbtzusd, xltcxxbt
  • designed for Australian tax return, e.g. assuming financial year end between June and July

trading logs pycgt can process

A csv file with following column:

  • Type
    • optional, transaction type
  • Exchange
    • optional, the exchange where the trade was made
  • Datetime
    • important, when the trade happened
  • Operation
    • important, either 'Buy' or 'Sell' if it's a trading transaction
  • Pair
    • important, one of "btcusd, btcaud, ltcusd, nmcusd, xethxxbt, xethzusd, ethusd, xltczusd, xxbtzusd, xltcxxbt"
  • BTC
    • optional, the BTC amount issued with the trade
  • LTC
    • optional, the LTC amount issued with the trade
  • NMC
    • optional, the NMC amount issued with the trade
  • USD
    • the USD amount issued with the trade
  • AUD
    • the AUD amount issued with the trade
  • Fee(BTC)
    • optional, fees paid in BTC
  • Fee(LTC)
    • optional, fees paid in LTC
  • Fee(NMC)
    • optional, fees paid in NMC
  • Fee(USD)
    • optional, fees paid in USD
  • Fee(AUD)
    • optional, fees paid in USD
  • BTCAUD
    • optional, BTCAUD exchange rate at "Datetime"
  • BTCUSD
    • optional, BTCUSD exchange rate at "Datetime"
  • LTCUSD
    • optional, LTCUSD exchange rate at "Datetime"
  • NMCUSD
    • optional, NMCUSD exchange rate at "Datetime"
  • AUDUSD
    • optional, AUDUSD exchange rate at "Datetime"
  • Comments
    • optional, just any comments

A csv example (see example.csv):

Type,Exchange,Datetime,Operation,Pair,BTC,LTC,USD,AUD,Fee(BTC),Fee(LTC),Fee(USD),Fee(AUD),BTCUSD,LTCUSD,LTCBTC,AUDUSD,Comments
Market,Coinbase,"2015-12-12T09:11:00.711Z",Buy,BTCUSD,1,,,420,525,,,1.61,1.99,420,,,0.8,
Market,Coinbase,"2017-07-07T13:40:11.735Z",Sell,BTCUSD,1,,,1838.53,2298.1625,,,4.71,6.05,1838.53,,,0.8,

How to run it

python3 is required, using virtualenv is recommended

1. Prepare python environment

python3.x -m venv .virtualenv       # install virtualenv
source .virtualenv/bin/activate     # activate virtualenv
pip install --upgrade pip           # upgrade pip
pip install -r requirements.txt     # install required packages

2. Run command to generate tax return statements and reports

python main.py [csv files] # multiple csv files are supported, use space to seperate them

Example:

python main.py example.csv

if everything is ok, the output would be:

ain_or_loss,aud,discountable,buy_transaction.aud,buy_transaction.volume,buy_transaction.datetime,buy_transaction.operation,buy_transaction.pair,buy_transaction.usd,position.asset,position.aud,position.initial_volume,position.price,position.volume,matched,sell_transaction.aud,sell_transaction.volume,sell_transaction.datetime,sell_transaction.operation,sell_transaction.pair,sell_transaction.usd
gain,1418.53,Yes,420.0,1.0,2015-12-12 09:11:00.711000+00:00,buy,btcusd,0.0,btc,420.0,1.0,420.0,1.0,1.0,1838.53,1.0,2017-07-07 13:40:11.735000+00:00,sell,btcusd,0.0
========================================================
Tax return report for year: 2016
Gross gains of the year: $0.00 AUD
Discountable gains of the year: $0.00 AUD
Non-discountable gains of the year: $0.00 AUD
Taxable gains of the year: $0.00 AUD
Losses carried from previous year: - $0.00 AUD
Losses of this year only: - $1.61 AUD
Total losses at the end of the year: - $1.61 AUD
Net gains of the year: - $1.61 AUD
Portfolio of the year:
 btc: 1.0
 ltc: 0
 nmc: 0
 eth: 0
========================================================

========================================================
Tax return report for year: 2018
Gross gains of the year: $1418.53 AUD
Discountable gains of the year: $1418.53 AUD
Non-discountable gains of the year: $0.00 AUD
Taxable gains of the year: $709.26 AUD
Losses carried from previous year: - $1.61 AUD
Losses of this year only: - $0.00 AUD
Total losses at the end of the year: - $1.61 AUD
Net gains of the year:  $707.65 AUD
Portfolio of the year:
 btc: 0.0
 ltc: 0
 nmc: 0
 eth: 0
========================================================

License

Distributed under the GNU General Public License v3.0. See LICENSE for more information.

Contact

Rob Lao - viewpl(at)gmail(dot)com