docs: fix README to match actual project structure and tooling

- Replace pip commands with uv equivalents
- Fix run command from 'python -m src.main' to 'python -m polymarket_insider_tracker'
- Update project structure tree to reflect actual src/polymarket_insider_tracker/ layout

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
pselamy
2026-03-10 02:02:52 +00:00
co-authored by Claude Opus 4.6
parent c6f41ea29f
commit de5e2592e8
+17 -25
View File
@@ -126,13 +126,13 @@ docker compose up -d
docker compose ps docker compose ps
# Install Python dependencies # Install Python dependencies
pip install -e . uv sync --all-extras
# Run database migrations # Run database migrations
alembic upgrade head uv run alembic upgrade head
# Run the tracker # Run the tracker
python -m src.main uv run python -m polymarket_insider_tracker
``` ```
### Docker Services ### Docker Services
@@ -188,24 +188,16 @@ LIQUIDITY_IMPACT_THRESHOLD=0.02
``` ```
polymarket-insider-tracker/ polymarket-insider-tracker/
├── src/ ├── src/
── ingestor/ # Real-time market data ingestion ── polymarket_insider_tracker/
├── clob_client.py # Polymarket CLOB API wrapper ├── __main__.py # CLI entry point
── websocket.py # WebSocket event handler ── pipeline.py # Core detection pipeline
├── profiler/ # Wallet analysis ├── ingestor/ # Real-time market data ingestion
│ │ ├── analyzer.py # Core wallet profiling logic │ ├── clob_client.py # Polymarket CLOB API wrapper
│ │ ── chain.py # Polygon blockchain client ── websocket.py # WebSocket event handler
── funding.py # Funding chain tracer ── profiler/ # Wallet analysis
│ ├── detector/ # Anomaly detection engines ├── detector/ # Anomaly detection engines
├── fresh_wallet.py ├── alerter/ # Notification dispatch
── size_anomaly.py ── storage/ # Persistence layer
│ │ ├── sniper.py # DBSCAN clustering
│ │ └── scorer.py # Composite risk scoring
│ ├── alerter/ # Notification dispatch
│ │ ├── formatter.py # Alert message formatting
│ │ └── dispatcher.py # Multi-channel delivery
│ └── storage/ # Persistence layer
│ ├── models.py # SQLAlchemy models
│ └── repos.py # Repository pattern
├── tests/ # Test suite ├── tests/ # Test suite
├── scripts/ ├── scripts/
│ └── backtest.py # Historical analysis │ └── backtest.py # Historical analysis
@@ -289,16 +281,16 @@ Contributions are welcome! Please read our Contributing Guide before submitting
```bash ```bash
# Install dev dependencies # Install dev dependencies
pip install -e ".[dev]" uv sync --all-extras
# Run tests # Run tests
pytest uv run pytest
# Run linting # Run linting
ruff check src/ uv run ruff check src/
# Run type checking # Run type checking
mypy src/ uv run mypy src/
``` ```
--- ---