Skip to content

Commit f5b9cc4

Browse files
committed
chore: repo cleanup — remove runtime files, fix docs, simplify TODO
- .gitignore: add patterns for runtime TXT files (memories, signals, DCA, neural weights, trainer timestamps) and coin subdirectories (BTC/ETH/XRP/DOGE/BNB) - Remove 38 runtime-generated TXT/DB files from git tracking (git rm --cached) - Consolidate DB files: move market_data.db and portfolio_optimization.db into app/ - Remove stale root-level order_management.db-shm / .db-wal WAL artefacts - README.md, QUICK_START.md, DEVELOPMENT_WORKFLOW.md: fix repo names, stale status references, phantom file paths, Windows command syntax - TODO.md: replace 281-line inline roadmap with a concise pointer to the GitHub project board (https://github.com/users/sjackson0109/projects/11)
1 parent f5c620d commit f5b9cc4

47 files changed

Lines changed: 54 additions & 352 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/DEVELOPMENT_WORKFLOW.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ This document outlines the development workflow for transitioning PowerTrader AI
44

55
## 🎯 Overview
66

7-
**Current State**: Advanced prototype (40-50% production ready)
7+
**Current State**: Phase 1 (Security Foundations) substantially complete
88
**Target**: Production-grade enterprise trading platform
99
**Timeline**: 16 weeks organized in 4 phases
1010
**Methodology**: Agile development with security-first approach
1111

1212
## 📋 Project Structure
1313

1414
### GitHub Project Organization
15-
- **Repository**: PowerTrader_AI
15+
- **Repository**: `sjackson0109/PowerTraderAI`
1616
- **Main Branch**: `main` (production-ready code)
1717
- **Development Branch**: `development-phase1` through `development-phase4`
1818
- **Feature Branches**: `feature/task-description`
@@ -276,8 +276,8 @@ This document outlines the development workflow for transitioning PowerTrader AI
276276

277277
1. **Repository Setup**
278278
```bash
279-
git clone https://github.com/[username]/PowerTrader_AI.git
280-
cd PowerTrader_AI
279+
git clone https://github.com/sjackson0109/PowerTraderAI.git
280+
cd PowerTraderAI
281281
python -m venv .venv
282282
source .venv/bin/activate # or .venv\Scripts\activate on Windows
283283
pip install -r requirements.txt

.gitignore

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,9 @@ futures_*_onoff.txt
200200
*_dca_signal.txt
201201
neural_*.txt
202202
memory_*.txt
203+
memories_*.txt
204+
signals_dca_*.txt
205+
trainer_last_training_time.txt
203206
*.html
204207
alerts_version.txt
205208

@@ -226,3 +229,11 @@ app/AVAX/
226229
.DS_Store
227230
Thumbs.db
228231
desktop.ini
232+
233+
# Local-only skills (not committed to repo)
234+
.github/skills/
235+
236+
# Specific files to ignore
237+
app/*.db-shm
238+
app/*.db-wal
239+
app/*.txt

QUICK_START.md

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
## 📍 Current Status Summary
66

7-
- **Current State:** Advanced prototype (40-50% production ready)
8-
- **Critical Issue:** System not safe for live trading due to security vulnerabilities
7+
- **Current State:** Phase 1 (Security Foundations) substantially complete — see GitHub issues for active backlog
8+
- **Active Backlog:** Feature issues #100#106 raised (Personas, Multi-LLM, MCP, Macro Data, Sentiment, Risk Metrics, Docker)
99
- **Development Plan:** 4-phase approach over 16 weeks
10-
- **Immediate Need:** Phase 1 security fixes before any live trading
10+
- **Immediate Need:** Phase 2 functional completeness
1111

1212
## 🚨 BEFORE YOU START - SAFETY FIRST
1313

@@ -19,10 +19,16 @@
1919

2020
```bash
2121
# 1. Backup current system
22-
cp -r PowerTrader_AI PowerTrader_AI_BACKUP_$(date +%Y%m%d)
22+
# Windows (PowerShell):
23+
Copy-Item -Recurse PowerTraderAI "PowerTraderAI_BACKUP_$(Get-Date -Format yyyyMMdd)"
24+
# Linux/Mac:
25+
# cp -r PowerTraderAI PowerTraderAI_BACKUP_$(date +%Y%m%d)
2326

2427
# 2. Verify no live trading is occurring
25-
grep -r "paper_trading.*False" app/ && echo "⚠️ LIVE TRADING ENABLED - DISABLE NOW"
28+
# Windows (PowerShell):
29+
Select-String -Path app\*.py -Pattern 'paper_trading.*False'
30+
# Linux/Mac:
31+
# grep -r "paper_trading.*False" app/ && echo "⚠️ LIVE TRADING ENABLED - DISABLE NOW"
2632

2733
# 3. Create development branch
2834
git checkout -b development-phase1
@@ -33,7 +39,7 @@ git checkout -b development-phase1
3339
### Step 1: Environment Setup (5 minutes)
3440
```bash
3541
# Clone or navigate to repository
36-
cd PowerTrader_AI
42+
cd PowerTraderAI
3743

3844
# Activate virtual environment
3945
.venv\Scripts\activate # Windows
@@ -43,7 +49,7 @@ cd PowerTrader_AI
4349
pip install -r requirements.txt
4450

4551
# Verify system status
46-
python app/pt_comprehensive_test.py
52+
python app/test_dependencies.py
4753
```
4854

4955
### Step 2: GitHub Project Setup (10 minutes)
@@ -65,7 +71,8 @@ python scripts/create_github_issues.py --token YOUR_TOKEN --owner YOUR_USERNAME
6571
### Step 3: Start Phase 1 Development (NOW)
6672
```bash
6773
# Review Phase 1 priorities
68-
cat TODO.md | grep -A 20 "Phase 1:"
74+
# Windows: type TODO.md | findstr /A /C:"Phase 1:"
75+
# Linux/Mac: cat TODO.md | grep -A 20 "Phase 1:"
6976

7077
# Pick first critical task
7178
git checkout -b feature/secure-credential-management

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -58,8 +58,8 @@ PowerTrader AI+ is a comprehensive, institutional-quality trading platform that
5858
### Installation
5959
```bash
6060
# Clone the repository
61-
git clone <repository-url>
62-
cd PowerTrader_AI
61+
git clone https://github.com/sjackson0109/PowerTraderAI
62+
cd PowerTraderAI
6363

6464
# Create and activate virtual environment (STRONGLY recommended)
6565
python -m venv .venv
@@ -85,7 +85,7 @@ python pt_hub.py
8585
### Quick Installation (One-Command Setup)
8686
```bash
8787
# For experienced users - complete setup in one command
88-
git clone <repository-url> && cd PowerTrader_AI && python -m venv .venv && .venv\Scripts\activate && python install_dependencies.py && cd app && python pt_hub.py
88+
git clone https://github.com/sjackson0109/PowerTraderAI && cd PowerTraderAI && python -m venv .venv && .venv\Scripts\activate && python install_dependencies.py && cd app && python pt_hub.py
8989
```
9090

9191
### Troubleshooting Installation
@@ -108,21 +108,25 @@ python install_dependencies.py
108108
### Desktop Application
109109

110110
```bash
111-
# Launch the full desktop interface
112-
python app/pt_desktop_app.py
111+
# Windows: double-click start_powertrader.bat, or run directly:
112+
start_powertrader.bat
113+
114+
# Alternatively, launch the hub directly:
115+
python app/pt_hub.py
113116
```
114117

115118
## 📁 Project Structure
116119

117120
```
118-
PowerTrader_AI/
121+
PowerTraderAI/
119122
├── README.md # Main project documentation (this file)
120123
├── requirements.txt # Python dependencies
121124
├── LICENSE # Project license
125+
├── start_powertrader.bat # Windows launcher
122126
123127
├── app/ # Main application code
124-
│ ├── pt_hub.py # Core PowerTrader Hub interface
125-
│ ├── pt_desktop_app.py # Desktop application launcher
128+
│ ├── pt_hub.py # Core PowerTrader Hub (main entry point)
129+
│ ├── pt_server.py # Headless server entry point (Docker/VPS)
126130
│ ├── institutional_trading.py # Enterprise trading engine
127131
│ ├── compliance_audit_system.py # Regulatory compliance
128132
│ ├── portfolio_optimizer.py # Modern Portfolio Theory
@@ -149,9 +153,9 @@ PowerTrader_AI/
149153

150154
## 📋 System Requirements
151155

152-
- **Python**: 3.8 or higher
153-
- **Operating System**: Windows, macOS, or Linux
154-
- **Memory**: 4GB RAM minimum (8GB recommended for institutional features)
156+
- **Python**: 3.11 or higher (3.13 recommended)
157+
- **Operating System**: Windows 10/11 (primary), macOS, or Linux
158+
- **Memory**: 8GB RAM minimum (16GB recommended)
155159
- **Storage**: 2GB free space
156160
- **Network**: Internet connection for market data
157161

0 commit comments

Comments
 (0)