scoobs
/
cryptools-mirror
mirror of https://github.com/scoobybejesus/cryptools.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Provided clarity on the code's purpose

This commit is contained in:
scoobybejesus 2019-08-26 14:08:00 -04:00 committed by GitHub
parent 29866eef35
commit 048bba801d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -2,10 +2,11 @@
### Accounting library for cryptocurrency transaction activity.
It provides a way to measure cryptocurrency activity in one's home currency (the default value is USD, but anything can be used).
Reports may be exported as CSV files that reflect income/expense/gains/losses.
The software provides a way to measure cryptocurrency activity in one's home currency (the default value is USD, but anything can be used).
Given a CSV file reflecting the user's entire cryptocurrency transaction history, the software will process that activity in a way that assigns cost basis at the date of purchase/exchange/receipt, preserves the character (date purchased and cost basis, most notably) of all holdings up until the time they are disposed, and when holdings are disposed the gain or loss from sale/exchange/disposal will be computed (including whether the gain or loss is short-term or long-term).
Reports that reflect income/expense/gains/losses may be exported as CSV files, and the user can supply the desired relative or absolute path for where the reports are saved.
The activity that gets imported **must** be in a prescribed form that effectively looks like this:
The activity that gets imported **must** be in a prescribed form (a CSV file) that effectively looks like this:
|txDate |proceeds|memo |1 |2 |3 |4 |5 |
@ -24,8 +25,9 @@ The activity that gets imported **must** be in a prescribed form that effectivel
|9/1/16 |400 |NINTH | |-0.5 | |200 | |
|10/1/16|900 |TENTH | |1 | |-200 | |
|11/1/16|0 |ELEVENTH| |-1.5 |1.5 | | |
|12/1/16|2000 |TWELFTH | | |-1.5 | |400 |
|12/1/16|2000 |TWELFTH*| | |-1.5 | |400 |
\* this last transaction is an example of how a user might reflect an exchange via Shapeshift or similar services, where one currency is spent from one wallet and a different currency is received in another wallet.
#### CSV file components