diff --git a/README.md b/README.md index 53c7c63..666a0c0 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,45 @@ ![Test program/library](https://gitfub.space/Jmaa/crypto-tax/actions/workflows/python-test.yml/badge.svg) +Tool to automatically perform tax computations of crypto transactions from the danish perspective. +Produces an Excel report containing the following sheets: -WIP +- **Overview Sheet**: An overview sheet with the suggested report values. +- **Current Assets**: Containing currently held assets. +- **Ledger**: Ledger of all registered transactions. +- Various **FIFO** sheets for the different asset classes. + +## Usage + +Make a `/secrets` folder, and place relevant secrets there. + +Run `python -m crypto_tax` + +## Disclaimer + +This tool is a work in progress, and may contain outdated or plain faulty +logic. The information gathered from crypto exchanges may be incorrect. + +When using the produced reports, you acknowledge that you bear the full +responsiblity of reporting the correct information to SKAT, and that you have +validated the generated output. + +The report suggestions are informal suggestions, and is not professional +guidance. I bear no responsiblity for faults in the generated tax reports. + +## TODO + +This tool is a work in progress: + +- [ ] Support Partisia Blockchain +- [ ] Fix Kucoin issues. +- [ ] Adjust the account provider column. +- [X] Produce Excel output file: + * Sheet 1: Gives a basic overview, including computed tax values from the rest of + the sheet, and reasonings for these. Gives an overview of the other sheets. + * Sheet 2: Current assets, including FIFO acquisition prices. + * Sheet 3: Historic sales, with FIFO. ## Dependencies diff --git a/setup.py b/setup.py index c30afb7..7298f33 100644 --- a/setup.py +++ b/setup.py @@ -13,11 +13,49 @@ PACKAGE_NAME = 'crypto_tax' PACKAGE_DESCRIPTION = """ # Crypto Tax. -WIP +Tool to automatically perform tax computations of crypto transactions from the danish perspective. + +Produces an Excel report containing the following sheets: + +- **Overview Sheet**: An overview sheet with the suggested report values. +- **Current Assets**: Containing currently held assets. +- **Ledger**: Ledger of all registered transactions. +- Various **FIFO** sheets for the different asset classes. + +## Usage + +Make a `/secrets` folder, and place relevant secrets there. + +Run `python -m crypto_tax` + +## Disclaimer + +This tool is a work in progress, and may contain outdated or plain faulty +logic. The information gathered from crypto exchanges may be incorrect. + +When using the produced reports, you acknowledge that you bear the full +responsiblity of reporting the correct information to SKAT, and that you have +validated the generated output. + +The report suggestions are informal suggestions, and is not professional +guidance. I bear no responsiblity for faults in the generated tax reports. + +## TODO + +This tool is a work in progress: + +- [ ] Support Partisia Blockchain +- [ ] Fix Kucoin issues. +- [ ] Adjust the account provider column. +- [X] Produce Excel output file: + * Sheet 1: Gives a basic overview, including computed tax values from the rest of + the sheet, and reasonings for these. Gives an overview of the other sheets. + * Sheet 2: Current assets, including FIFO acquisition prices. + * Sheet 3: Historic sales, with FIFO. """.strip() PACKAGE_DESCRIPTION_SHORT = """ -""".strip() +Tool to automatically perform tax computations of crypto transactions from the danish perspective.""".strip() def parse_version_file(text: str) -> str: