Metadata-Version: 2.1
Name: rp2
Version: 0.9.6
Summary: Privacy-focused, free, open-source cryptocurrency US tax calculator, up to date for fiscal year 2021: it handles multiple coins/exchanges and computes long/short-term capital gains, cost bases, in/out lot relationships/fractioning, and account balances. It supports FIFO and LIFO and it generates data that tax accountants can understand, even if they are not cryptocurrency experts (e.g. form 8949).
Home-page: https://github.com/eprbell/rp2
Author: eprbell
License: Apache License 2.0
Project-URL: Source Code, https://github.com/eprbell/rp2
Project-URL: Contact, https://eprbell.github.io/eprbell/about.html
Project-URL: User Documentation, https://github.com/eprbell/rp2/blob/main/README.md
Project-URL: Developer Documentation, https://github.com/eprbell/rp2/blob/main/README.dev.md
Description: <!--- Copyright 2021 eprbell --->
        
        <!--- Licensed under the Apache License, Version 2.0 (the "License"); --->
        <!--- you may not use this file except in compliance with the License. --->
        <!--- You may obtain a copy of the License at --->
        
        <!---     http://www.apache.org/licenses/LICENSE-2.0 --->
        
        <!--- Unless required by applicable law or agreed to in writing, software --->
        <!--- distributed under the License is distributed on an "AS IS" BASIS, --->
        <!--- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. --->
        <!--- See the License for the specific language governing permissions and --->
        <!--- limitations under the License. --->
        
        # RP2 v0.9.6
        [![Static Analysis / Main Branch](https://github.com/eprbell/rp2/actions/workflows/static_analysis.yml/badge.svg)](https://github.com/eprbell/rp2/actions/workflows/static_analysis.yml)
        [![Documentation Check / Main Branch](https://github.com/eprbell/rp2/actions/workflows/documentation_check.yml/badge.svg)](https://github.com/eprbell/rp2/actions/workflows/documentation_check.yml)
        [![Unix Unit Tests / Main Branch](https://github.com/eprbell/rp2/actions/workflows/unix_unit_tests.yml/badge.svg)](https://github.com/eprbell/rp2/actions/workflows/unix_unit_tests.yml)
        [![Windows Unit Tests / Main Branch](https://github.com/eprbell/rp2/actions/workflows/windows_unit_tests.yml/badge.svg)](https://github.com/eprbell/rp2/actions/workflows/windows_unit_tests.yml)
        [![CodeQL/Main Branch](https://github.com/eprbell/rp2/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/eprbell/rp2/actions/workflows/codeql-analysis.yml)
        
        ## Table of Contents
        * **[Introduction](https://github.com/eprbell/rp2/tree/main/README.md#introduction)**
          * [How RP2 Operates](https://github.com/eprbell/rp2/tree/main/README.md#how-rp2-operates)
        * **[License](https://github.com/eprbell/rp2/tree/main/README.md#license)**
        * **[Download](https://github.com/eprbell/rp2/tree/main/README.md#download)**
        * **[Installation](https://github.com/eprbell/rp2/tree/main/README.md#installation)**
          * [Ubuntu Linux](https://github.com/eprbell/rp2/tree/main/README.md#installation-on-ubuntu-linux)
          * [macOS](https://github.com/eprbell/rp2/tree/main/README.md#installation-on-macos)
          * [Windows 10](https://github.com/eprbell/rp2/tree/main/README.md#installation-on-windows-10)
          * [Other Unix-like Systems](https://github.com/eprbell/rp2/tree/main/README.md#installation-on-other-unix-like-systems)
        * **[Running](https://github.com/eprbell/rp2/tree/main/README.md#running)**
        * **[Input and Output Files](https://github.com/eprbell/rp2/tree/main/README.md#input-and-output-files)**
        * **[Reporting Bugs](https://github.com/eprbell/rp2/tree/main/README.md#reporting-bugs)**
        * **[Contributing](https://github.com/eprbell/rp2/tree/main/README.md#contributing)**
        * **[Developer Documentation](https://github.com/eprbell/rp2/tree/main/README.md#developer-documentation)**
        * **[Frequently Asked Questions](https://github.com/eprbell/rp2/tree/main/README.md#frequently-asked-questions)**
        * **[Change Log](https://github.com/eprbell/rp2/tree/main/README.md#change-log)**
        
        ## Introduction
        [RP2](https://pypi.org/project/rp2/) is a privacy-focused, free, [open-source](https://github.com/eprbell/rp2) US cryptocurrency tax calculator, that is up to date for Fiscal Year 2021. Preparing crypto taxes can be a daunting and error-prone task, especially if multiple transactions, coins, exchanges and wallets are involved. This task could be delegated to a crypto tax preparation service, but many crypto users value their privacy and prefer not to send their transaction information to third parties unnecessarily. Additionally, many of these services cost money. RP2 solves all of these problems:
        * it manages the complexity related to coin flows and tax calculation and it generates data that accountants can understand (in the format of form 8949), even if they are not cryptocurrency experts;
        * it prioritizes user privacy by storing crypto transactions and tax results on the user's computer and not sending them anywhere else;
        * it's free and open-source;
        * it supports the [FIFO](https://www.investopedia.com/terms/f/fifo.asp) and [LIFO](https://www.investopedia.com/terms/l/lifo.asp) accounting methods.
        
        RP2 reads in a user-prepared spreadsheet containing crypto transactions. It then uses high-precision math to calculate long/short term capital gains, cost bases, balances, average price, in/out lot relationships/fractions, and finally it generates output spreadsheets.
        
        It has a programmable plugin architecture for [output generators](https://github.com/eprbell/rp2/tree/main/src/rp2/plugin/report), accounting methods and countries. The builtin plugins are US-specific, but RP2's architecture makes it possible to contribute additional output generators for different countries or for different US-based cases. The builtin plugins are:
        * tax_report_us: generates a tax report meant to be read by tax preparers (in the format of form 8949);
        * rp2_full_report: generates a comprehensive report, with complete transaction history, lot relationships/fractions and computation details.
        
        RP2 has extensive [unit test](https://github.com/eprbell/rp2/tree/main/tests/) coverage to reduce the risk of regression.
        
        **IMPORTANT DISCLAIMERS**:
        * RP2 offers no guarantee of correctness (read the [license](https://github.com/eprbell/rp2/tree/main/LICENSE)): always verify results with the help of a tax professional.
        * The author of RP2 is not a tax professional, but has used RP2 personally for a few years.
        
        ### How RP2 Operates
        RP2 treats virtual currency as property for tax purposes, as per [IRS Virtual Currency Guidance](https://www.irs.gov/newsroom/irs-reminds-taxpayers-to-report-virtual-currency-transactions).
        
        RP2 suports the FIFO and LIFO accounting methods: however, in and out lots typically don't have matching amounts, so RP2 fractions them, maps in/out lot fractions and computes the resulting cost bases and capital gains for each lot fraction.
        
        RP2 groups lot fractions into the following taxable event categories, each of which has a [specific tax treatment](https://github.com/eprbell/rp2/tree/main/docs/user_faq.md#which-crypto-tax-forms-to-file):
        * [AIRDROP](https://github.com/eprbell/rp2/tree/main/docs/user_faq.md#how-to-handle-airdrops): gains from airdrops;
        * DONATE: donations to charitable organizations;
        * GIFT: gifts to parties who are not charitable organizations (not tax-deductible).
        * [HARDFORK](https://github.com/eprbell/rp2/tree/main/docs/user_faq.md#how-to-handle-hard-forks): gains from hard forks;
        * INTEREST: gains from interest;
        * [MINING](https://github.com/eprbell/rp2/tree/main/docs/user_faq.md#how-to-handle-income-from-mining): gains from mining;
        * MOVE: the fee for moving currency between two accounts controlled by the same owner; these may not be taxable or tax deductible but they still affect the accounting method order so they are tracked;
        * SELL: specifically, sale and [exchange of one cryptocurrency for another](https://github.com/eprbell/rp2/tree/main/docs/user_faq.md#how-to-handle-conversion-of-a-cryptocurrency-to-another). RP2 splits them in two subcategories:
          * long-term capital gains, if the lot was held for more than 1 year, or
          * short-term capital gains otherwise;
        * [STAKING](https://github.com/eprbell/rp2/tree/main/docs/user_faq.md#how-to-handle-income-from-staking): gains from staking;
        * WAGES: income from crypto wages.
        
        For each of these categories RP2 generates an output spreadsheet with transaction details and computed gains/losses (see [Input and Output Files](https://github.com/eprbell/rp2/tree/main/README.md#input-and-output-files) for more details). Users can give this output to their tax preparer with the rest of their tax documentation (see also FAQ on [which tax forms to file](https://github.com/eprbell/rp2/tree/main/docs/user_faq.md#which-crypto-tax-forms-to-file)). Note that buying cryptocurrency using fiat currency is not a taxable event.
        
        **NOTE ON NFTs**: Read the [FAQ on NFTs](https://github.com/eprbell/rp2/tree/main/docs/user_faq.md#how-to-handle-nfts) to learn about how RP2 treats NFTs.
        
        ## License
        RP2 is released under the terms of Apache License Version 2.0. For more information see [LICENSE](https://github.com/eprbell/rp2/tree/main/LICENSE) or <http://www.apache.org/licenses/LICENSE-2.0>.
        
        ## Download
        The latest version of RP2 can be downloaded at: <https://pypi.org/project/rp2/>
        
        ## Installation
        RP2 has been tested on Ubuntu Linux, macOS and Windows 10 but it should work on all systems that have Python version 3.7.0 or greater.
        
        ### Installation on Ubuntu Linux
        Open a terminal window and enter the following commands:
        ```
        sudo apt-get update
        sudo apt-get install python3 python3-pip
        ```
        
        Then install RP2 Python package requirements:
        ```
        pip install rp2
        ```
        ### Installation on macOS
        First make sure [Homebrew](https://brew.sh) is installed, then open a terminal window and enter the following commands:
        ```
        brew update
        brew install python3
        ```
        
        Then install RP2 Python package requirements:
        ```
        pip install rp2
        ```
        ### Installation on Windows 10
        First make sure [Python](https://python.org) 3.7 or greater is installed (in the Python installer window be sure to click on "Add Python to PATH"), then open a PowerShell window and enter the following:
        ```
        pip install rp2
        ```
        
        ### Installation on Other Unix-like Systems
        * install python 3.7 or greater
        * install pip3
        * `pip install rp2`
        
        ## Running
        Before running RP2, the user must prepare two files:
        * an ODS-format spreadsheet, containing crypto transactions (ODS-format files can be opened and edited with [LibreOffice](https://www.libreoffice.org/) and many other spreadsheet applications);
        * a JSON config file, describing the format of the spreadsheet file: what value each column corresponds to (e.g. timestamp, amount, exchange, fee, etc.) and which cryptocurrencies and exchanges to expect.
        
        The formats of these files are described in detail in the [Input Files](https://github.com/eprbell/rp2/tree/main/docs/input_files.md) section of the documentation.
        
        Examples of an input spreadsheet and its respective config file:
        * [input/crypto_example.ods](https://github.com/eprbell/rp2/tree/main/input/crypto_example.ods)
        * [config/crypto_example.config](https://github.com/eprbell/rp2/tree/main/config/crypto_example.config) (if desired, this config file can be used as boilerplate).
        
        After reading the input files, RP2 computes taxes and generates output files, which contain information on long/short capital gains, cost bases, balances, average price, in/out lot relationships and fractions. They are described in detail in the [Output Files](https://github.com/eprbell/rp2/tree/main/docs/output_files.md) section of the documentation.
        
        To try RP2 with example files, download [crypto_example.ods](https://github.com/eprbell/rp2/tree/main/input/crypto_example.ods) and [crypto_example.config](https://github.com/eprbell/rp2/tree/main/config/crypto_example.config). Let's call `<download_directory>` the location of the downloaded files.
        
        To generate output for the example files open a terminal window (or PowerShell if on Windows) and enter the following commands:
          ```
          cd <download_directory>
          rp2_us -o output -p crypto_example_ crypto_example.config crypto_example.ods
          ```
        Results are generated in the `output` directory and logs are stored in the `log` directory.
        
        To print command usage information for the `rp2_us` command:
          ```
          rp2_us --help
          ```
        
        ## Input and Output Files
        Read the [input files](https://github.com/eprbell/rp2/tree/main/docs/input_files.md) and [output files](https://github.com/eprbell/rp2/tree/main/docs/output_files.md) documentation.
        
        ## Reporting Bugs
        Read the [Contributing](https://github.com/eprbell/rp2/tree/main/CONTRIBUTING.md#reporting-bugs) document.
        
        ## Contributing
        Read the [Contributing](https://github.com/eprbell/rp2/tree/main/CONTRIBUTING.md) document.
        
        ## Developer Documentation
        Read the [developer documentation](https://github.com/eprbell/rp2/tree/main/README.dev.md).
        
        ## Frequently Asked Questions
        Read the [user FAQ list](https://github.com/eprbell/rp2/tree/main/docs/user_faq.md) and the [developer FAQ list](https://github.com/eprbell/rp2/tree/main/docs/developer_faq.md).
        
        ## Change Log
        Read the [Change Log](https://github.com/eprbell/rp2/tree/main/CHANGELOG.md) document.
        
        <!--- Copyright 2021 eprbell --->
        
        <!--- Licensed under the Apache License, Version 2.0 (the "License"); --->
        <!--- you may not use this file except in compliance with the License. --->
        <!--- You may obtain a copy of the License at --->
        
        <!---     http://www.apache.org/licenses/LICENSE-2.0 --->
        
        <!--- Unless required by applicable law or agreed to in writing, software --->
        <!--- distributed under the License is distributed on an "AS IS" BASIS, --->
        <!--- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. --->
        <!--- See the License for the specific language governing permissions and --->
        <!--- limitations under the License. --->
        
        # RP2 Change Log
        
        # v.0.9.6
        * fixed a bug in timestamp check: in and out lots were not allowed to have the same timestamp, but in certain scenarios it could happen (e.g. high-frequency trading)
        * fixed a subtle corner-case bug in LIFO, which caused the first gain/loss pair to be incorrect: the minimal input that reproduced the bug is now captured in one of the tests (test_data2.ods, sheet B1). This ensures there will not be a regression.
        * disable a link check in user faq: the link was failing the check (incorrectly) on Github actions
        * added large input test
        
        # v0.9.5
        * added new LIFO tests
        * minor fixes
        
        # v0.9.4
        * added accounting-method programmable plugin infrastructure: by subclassing AbstractAccountingMethod it's now possible to add support for a new accounting method (previously only FIFO was hard-coded in)
        * added accounting-method plugins: FIFO, LIFO
        * added accounting-method-specific tests, plus additional tests of internal classes (both new and old)
        * Added Legend sheet to tax_report_us output
        * updated documentation to reflect changes in this version
        * minor fixes
        
        ## v0.9.3
        * added country-specific programmable plugin infrastructure: by subclassing AbstractCountry it's now possible to add support for a new country (currently only US is supported)
        * abstracted out currency from APIs and code in general: references to "usd" have been changed to "fiat"
        * updated documentation to reflect changes in this version
        
        ## v0.9.2
        * Verified software is up to date for FY 2021
        * Wrote several answers in User FAQ document
        * Minor fixes
        
        ## v0.8.1
        * Added several new tests (from/to_year command line option variations and new transaction types)
        * Reworked time filter logic to fix two bugs related to -f and -t options:
          * with time filtering on, running sums reflected only filtered transactions, instead of all transactions (in other words, running sums should not be affected by filtering)
          * with time filtering on, number of fractions reflected also fractions with year higher than time filter
          * with time filtering on, sold lot percentages would be shown incorrectly in some cases
        * Updated documentation: various fixes and improvements
        
        ## v0.8.0
        * added new transaction types: AIRDROP, HARDFORK, INTEREST, MINING, STAKING, WAGES. Removed transaction type EARN, which used to encompass all the above types
        * revisited output generators: rp2_report was renamed to rp2_full_report and mock_8949_us was renamed to tax_report_us. The tax_report_us plugin now generates one sheet per taxable event type: Airdrops, Capital Gains, Donations, Gifts, Hard Forks, Interest, Investment Expense, Mining, Staking, Wages.
        * fixed bug in from/to_year logic: entry sets didn't consider the time filter in certain corner cases
        * updated documentation to reflect above changes
        
        ## v0.7.3
        * Added from/to_year command line option
        
        ## v0.7.2
        * Minor fixes related to Pypi package distribution and upload
        
        ## v0.7.1
        * Minor fixes related to Pypi package distribution and upload
        
        ## v0.7.0
        * First version uploaded to Pypi
        * Added pre-commit hooks
        * Added bandit security checks
        * Major revision of user and developer documentation
        * Fixed lint errors
        * Various bug fixes and improvements
        
        ## v0.6.0
        * First version tracked in change log
        * Added Python packaging support
        * Switched to high-precision math (decimal.Decimal)
        * Finished documentation (except FAQs)
        * Added bumpversion
        * Various bug fixes and improvements
        
Keywords: accounting,altcoin,bitcoin,BTC,capital gains,cost basis,crypto,cryptocurrency,ETH,ethereum,finance,form 8949,privacy,tax
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Office/Business :: Financial :: Accounting
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
