CryptoHub (Console Tool)

A command-line tool for crypto traders to:

• Download trading history from Kraken and Binance exchanges
• Fetch NBP (National Bank of Poland) exchange rates
• Calculate tax-relevant transaction data
• Export results to JSON and CSV formats

Features

• 🔄 Automatic trade history download from Kraken and Binance
• 💱 NBP exchange rate integration (for Poland Tax)
• 📊 Save downloaded trades and tax calculations as Excel documents
• ✏️ Possibility to modify or compose your own trade files for Tax calculation
• 🔒 Secure API key handling (stored locally in config files)
• 🗓️ Full tax year transaction processing

Quick Start - Download & Run

For those who just want to use the software without any setup:

1. Go to the Releases tab
2. Download the newest release (cryptohub.exe)
3. No Python installation or manual builds are required
4. Create a .env file next to the executable with your configuration (see Configuration)
5. Remember to configure at least one connection to Kraken or Binance in your .env file (you can have multiple connections to the same provider for different accounts)
   • IMPORTANT: For security, create API keys with READ-ONLY permissions. The application only reads your trading history and does not perform any trades or modifications to your account.
   • How to create a read-only Kraken API key
   • How to create a read-only Binance API key
6. Run the executable from Command Prompt or PowerShell:

cryptohub.exe /?

ℹ️ Note: When you download trades or calculate taxes, the tool generates Excel (.xlsx) files in your current working directory. These files contain all transaction data and tax calculations for easy review and record keeping.

Requirements

The following requirements are for developers who would like to download the repository and build/run manually or contribute to the project. If you just want to use the tool, refer to the Quick Start - Download & Run section.

• Python 3.11
• Internet connection for (Kraken, Binance, NBP)

Managing Python with Scoop

Check your Python installation and versions:

# Check current Python path
scoop which python

# List installed Python versions (Method 1)
Get-ChildItem -Path $env:SCOOP\apps\python* -Directory

# List installed Python versions (Method 2)
scoop info python

# Check Python version
python --version

Setup

Virtual Environment

You can create a virtual environment using your default Python or specify a particular version:

# Using default Python version
python -m venv venv

# Using specific Python version from Scoop
$env:SCOOP\apps\python\3.11.3\python.exe -m venv venv

# Activate virtual environment
# On Windows
venv\Scripts\activate

# On Linux/macOS
# source venv/bin/activate

Install Dependencies

With the virtual environment activated, install the required packages:

pip install -r requirements.txt

Usage

You can run the project as a module from the project root:

python -m cryptohub.main --KRAKEN_API_KEY_1 YOUR_KEY --KRAKEN_API_SECRET_1 YOUR_SECRET

Alternatively, if you wish to run an executable after building it, refer to the build instructions below.

Configuration

Environment Variables

Create a .env file in the project root directory with your configuration:

# Kraken account configuration
KRAKEN_1=My Account Name              # Optional account name
KRAKEN_API_KEY_1=your_api_key         # Required API key
KRAKEN_API_SECRET_1=your_api_secret   # Required API secret

# You can configure multiple Kraken accounts by incrementing the number:
KRAKEN_2=Second Account
KRAKEN_API_KEY_2=second_api_key
KRAKEN_API_SECRET_2=second_api_secret

# Binance account configuration
BINANCE_1=My Binance Account          # Optional account name
BINANCE_API_KEY_1=your_binance_api_key         # Required API key
BINANCE_API_SECRET_1=your_binance_api_secret   # Required API secret
# Optional regex filtering of trading pairs, e.g., to include only pairs ending with USDT or EUR.
BINANCE_PAIR_PATTERN_1=.*(USDT|EUR)$

# Tax calculation settings
SETTLEMENT_DAY=-1                     # Settlement day for tax calculations
TAX_YEAR=2024                         # Required tax year

# Tax PL Config - Cost moved from the previous year (default: 0.00)
PREVIOUS_YEAR_COST_FIELD36=0

Command Line Arguments

All environment variables can be overridden using command line arguments:

# Override tax year and settlement day
python -m cryptohub.main --TAX_YEAR 2024 --SETTLEMENT_DAY -1

# Override Kraken API credentials
python -m cryptohub.main --KRAKEN_1 "My Account" --KRAKEN_API_KEY_1 your_key --KRAKEN_API_SECRET_1 your_secret

However, the .env file is the preferred way to setup the CryptHub (comparing to passing the parameters via commandline parameters as stated above).

Configuration Priority

1. Command line arguments take precedence over environment variables
2. Environment variables from .env file are used as defaults
3. If neither is provided, default values are used where possible

Required Parameters

• TAX_YEAR: Must be provided either in .env or via command line
• At least one Kraken account must be configured with API key and secret

Build Executable

To build the executable (named cryptohub.exe), install PyInstaller and run the following command with your modified spec file:

pyinstaller main.spec

Development

To deactivate the virtual environment when you're done:

deactivate