Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .Jules/palette.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
**Learning:** Adding color-coded indicators (Green/Red) and emojis (💰, 📉) in CLI tools significantly reduces cognitive load when parsing financial data streams. It transforms a wall of text into a scannable narrative.
**Action:** For data-heavy CLI applications, always implement a semantic color system and visual anchors (icons/emojis) for key events.

## 2026-02-06 - CLI Accessibility Standards
**Learning:** CLI tools are surprisingly inaccessible without standard flags like `--no-color` and `--quiet`. Users expect these controls to integrate with scripts and accessibility tools.
**Action:** Always implement `argparse` with quiet/color-disable options for any CLI outputting more than 5 lines.
## 2026-02-11 - Accessibility in CLI Tools
**Learning:** Hardcoded ANSI colors exclude users with visual impairments or conflicting terminal themes. Providing a standard `--no-color` flag is a zero-cost accessibility win that respects user preference.
**Action:** Always wrap color codes in a configurable class and expose a disable mechanism via CLI arguments.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,33 @@ pip install -r requirements.txt

## Usage

Run the simulation script:
Run the simulation script with default settings:

```bash
python bitcoin_trading_simulation.py
```

### Options

You can customize the simulation with the following arguments:

- `--days`: Number of days to simulate (default: 60)
- `--initial-cash`: Initial cash amount (default: 10000)
- `--initial-price`: Initial Bitcoin price (default: 50000)
- `--volatility`: Volatility factor (default: 0.02)
- `--quiet`: Suppress daily ledger output (show only final results)
- `--no-color`: Disable colored output (for accessibility)

**Example:**

```bash
python bitcoin_trading_simulation.py --days 100 --initial-cash 5000 --quiet
```

## Tests

Run the test suite:

```bash
python test.py
python -m unittest test_bitcoin_trading.py
```
Binary file not shown.
Binary file added __pycache__/test_bitcoin_trading.cpython-312.pyc
Binary file not shown.
15 changes: 8 additions & 7 deletions bitcoin_trading_simulation.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import argparse
import sys
import numpy as np
import pandas as pd
import argparse
Expand Down Expand Up @@ -102,10 +104,10 @@ def simulate_trading(signals, initial_cash=10000, quiet=False):
if __name__ == "__main__":
parser = argparse.ArgumentParser(description='Bitcoin Trading Simulation')
parser.add_argument('--days', type=int, default=60, help='Number of days to simulate')
parser.add_argument('--initial-cash', type=float, default=10000, help='Initial cash amount')
parser.add_argument('--initial-price', type=float, default=50000, help='Initial Bitcoin price')
parser.add_argument('--initial-cash', type=float, default=10000.0, help='Initial cash amount')
parser.add_argument('--initial-price', type=float, default=50000.0, help='Initial Bitcoin price')
parser.add_argument('--volatility', type=float, default=0.02, help='Volatility factor')
parser.add_argument('--quiet', action='store_true', help='Suppress daily output')
parser.add_argument('--quiet', action='store_true', help='Suppress daily ledger output')
parser.add_argument('--no-color', action='store_true', help='Disable colored output')

args = parser.parse_args()
Expand All @@ -127,15 +129,14 @@ def simulate_trading(signals, initial_cash=10000, quiet=False):

# Final portfolio performance
final_value = portfolio['total_value'].iloc[-1]
initial_cash = args.initial_cash
profit = final_value - initial_cash
profit = final_value - args.initial_cash

# Compare with buy and hold strategy
buy_and_hold_btc = initial_cash / prices.iloc[0]
buy_and_hold_btc = args.initial_cash / prices.iloc[0]
buy_and_hold_value = buy_and_hold_btc * prices.iloc[-1]

print(f"\n{Colors.HEADER}{Colors.BOLD}------ Final Portfolio Performance ------{Colors.ENDC}")
print(f"Initial Cash: ${initial_cash:.2f}")
print(f"Initial Cash: ${args.initial_cash:.2f}")
print(f"Final Portfolio Value: ${final_value:.2f}")

if profit >= 0:
Expand Down
101 changes: 101 additions & 0 deletions test_bitcoin_trading.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,101 @@
import unittest
import sys
import io
import pandas as pd
import subprocess
from bitcoin_trading_simulation import Colors, simulate_trading, simulate_bitcoin_prices

class TestBitcoinTradingSimulation(unittest.TestCase):

def setUp(self):
# Reset Colors to default before each test to prevent side effects
Colors.HEADER = '\033[95m'
Colors.BLUE = '\033[94m'
Colors.GREEN = '\033[92m'
Colors.RED = '\033[91m'
Colors.ENDC = '\033[0m'
Colors.BOLD = '\033[1m'

def test_simulate_bitcoin_prices(self):
prices = simulate_bitcoin_prices(days=10, initial_price=100)
self.assertEqual(len(prices), 10)
self.assertEqual(prices.iloc[0], 100)

def test_colors_disable(self):
Colors.disable()
self.assertEqual(Colors.HEADER, '')
self.assertEqual(Colors.GREEN, '')
self.assertEqual(Colors.RED, '')

def test_quiet_mode_function(self):
# Create dummy signals
prices = pd.Series([100, 101, 102], name='Price')
signals = pd.DataFrame(index=prices.index)
signals['price'] = prices
signals['positions'] = 0.0

# Capture stdout
captured_output = io.StringIO()
sys.stdout = captured_output

simulate_trading(signals, quiet=True)

sys.stdout = sys.__stdout__
output = captured_output.getvalue()

# Expect no output in quiet mode (since no trades and quiet=True)
self.assertEqual(output, "")

def test_verbose_mode_function(self):
# Create dummy signals
prices = pd.Series([100, 101, 102], name='Price')
signals = pd.DataFrame(index=prices.index)
signals['price'] = prices
signals['positions'] = 0.0

# Capture stdout
captured_output = io.StringIO()
sys.stdout = captured_output

simulate_trading(signals, quiet=False)

sys.stdout = sys.__stdout__
output = captured_output.getvalue()

self.assertIn("Daily Trading Ledger", output)

def test_integration_no_color(self):
# Run the script via subprocess to verify --no-color
result = subprocess.run(
[sys.executable, 'bitcoin_trading_simulation.py', '--days', '5', '--no-color'],
capture_output=True,
text=True
)
# Check that ANSI codes are NOT present
self.assertNotIn('\033[', result.stdout)
# Check that the output is still meaningful
self.assertIn('Final Portfolio Performance', result.stdout)

def test_integration_quiet(self):
# Run the script via subprocess to verify --quiet
result = subprocess.run(
[sys.executable, 'bitcoin_trading_simulation.py', '--days', '5', '--quiet'],
capture_output=True,
text=True
)
# Check that Daily Ledger is NOT present
self.assertNotIn('Daily Trading Ledger', result.stdout)
# Check that Final Performance IS present
self.assertIn('Final Portfolio Performance', result.stdout)

def test_integration_args(self):
# Verify custom arguments work
result = subprocess.run(
[sys.executable, 'bitcoin_trading_simulation.py', '--days', '5', '--initial-cash', '500'],
capture_output=True,
text=True
)
self.assertIn('Initial Cash: $500.00', result.stdout)

if __name__ == '__main__':
unittest.main()