Skip to main content

Python SDK for the CobwebSim stock simulation and backtesting API. Compute 71 technical features, run backtests with realistic execution modeling, generate 27 plot types, and deploy strategies to Alpaca.

Project description

cobweb-py

Python SDK for realistic backtesting with CobwebSim.

Your backtest is lying to you. Most backtesters only model transaction fees. cobweb-py adds the friction costs they miss: bid-ask spread, slippage, and market impact.

Features

  • 71 technical features computed server-side (RSI, SMA, EMA, ATR, Bollinger, MACD, and more)
  • Realistic execution modeling with fees, spread, slippage, and market impact
  • 27 interactive Plotly charts (equity curves, drawdowns, regime analysis, trade logs)
  • Works with any OHLCV data — CSV files, pandas DataFrames, or yfinance

Installation

pip install cobweb-py

With visualization support (Plotly charts):

pip install cobweb-py[viz]

Requires Python 3.9+. No API key required.

Quick Start

import cobweb_py as cw

# 1. Connect & download data
sim = cw.CobwebSim("https://web-production-83f3e.up.railway.app")
asset_df = cw.from_yfinance("AAPL", "2020-01-01", "2024-12-31")
bench_df = cw.from_yfinance("SPY", "2020-01-01", "2024-12-31")

# 2. Enrich with technical features
rows = sim.enrich_rows(asset_df, feature_ids=[1, 2, 3, 11, 36, 14, 70, 71])

# 3. Score and generate signals
scores = cw.score_by_id(rows, {11: 0.3, 36: 0.3, 14: 0.4})
signals = cw.to_signals(scores, entry_th=0.20, exit_th=0.05, use_shorts=False)

# 4. Backtest with realistic friction
bt = sim.backtest(
    rows, signals=signals,
    compute_features=True, feature_ids=[70, 71],
    benchmark=bench_df,
    config=cw.BacktestConfig(initial_cash=10_000, exec_horizon="swing", fee_bps=1.0),
)

# 5. View results
cw.print_signal(bt)
metrics = cw.format_metrics(bt)
for label, value in metrics.items():
    print(f"{label}: {value}")

# 6. Save interactive charts
cw.plots.save_equity_plot(bt, out_html="out/equity.html")
cw.plots.save_metrics_table(bt, out_html="out/metrics.html")
cw.plots.save_trades_table(bt, out_html="out/trades.html")
cw.plots.save_score_plot(rows, scores, out_html="out/score.html")
cw.plots.save_price_and_score_plot(rows, scores, out_html="out/price_and_score.html")

Examples

See backtest_under_20 for a complete walkthrough notebook with explanations.

Open In Colab

API Reference

CobwebSim Client

sim = CobwebSim("https://web-production-83f3e.up.railway.app")
Method Description
sim.health() Check API status
sim.enrich(data, feature_ids=[...]) Compute technical features
sim.backtest(data, signals, config=...) Run backtest with realistic execution
sim.plots(data, bt, plot_ids=[...]) Generate interactive charts

BacktestConfig

BacktestConfig(
    initial_cash=10_000,       # Starting capital
    exec_horizon="swing",      # intraday | swing | longterm
    fee_bps=1.0,               # Broker fee (basis points)
    half_spread_bps=2.0,       # Bid-ask half-spread
    base_slippage_bps=1.0,     # Slippage
    impact_coeff=1.0,          # Market impact multiplier
    allow_margin=False,        # Allow short positions
    max_leverage=1.0,          # Maximum leverage
)

Scoring & Signals

# Weight features by ID
scores = score_by_id(rows, {11: 0.3, 36: 0.3, 14: 0.4})

# Convert to trading signals
signals = to_signals(scores, entry_th=0.20, exit_th=0.05, use_shorts=False)

Pipeline (High-Level)

from cobweb_py import Pipeline

pipe = Pipeline("https://web-production-83f3e.up.railway.app", "stock.csv")
result = pipe.run(weights={36: 0.3, 11: 0.3, 1: 0.4})
print(result["metrics"])

Helper Functions

Function Description
fix_timestamps(rows) Normalize dates to ISO format
load_csv(path) Load CSV into API-ready format
align(base, benchmark) Align two datasets by timestamp
to_signals(scores, entry_th, exit_th) Convert scores to buy/hold/sell
score_by_id(rows, weights) Weighted feature scoring
print_signal(bt) Print current signal
save_all_plots(sim, data, bt, plot_ids) Save interactive HTML charts
show_features() Print feature reference table
show_plots() Print plot reference table

Documentation

Full documentation at cobweb.market/docs.html.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cobweb_py-0.2.0.tar.gz (45.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cobweb_py-0.2.0-py3-none-any.whl (40.6 kB view details)

Uploaded Python 3

File details

Details for the file cobweb_py-0.2.0.tar.gz.

File metadata

  • Download URL: cobweb_py-0.2.0.tar.gz
  • Upload date:
  • Size: 45.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for cobweb_py-0.2.0.tar.gz
Algorithm Hash digest
SHA256 f15caa7a86b558ac2a2dda75be206e212c38afa86f9c14bd49b453b25363993d
MD5 1339fa6d841c43ce5b279c737a98d42d
BLAKE2b-256 5acb7e957883f349e4a8ba47a89ad011ed43bbef4a09c7f5322051c164f35065

See more details on using hashes here.

File details

Details for the file cobweb_py-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: cobweb_py-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 40.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for cobweb_py-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4a103d0f40ba2f4a53a9526f22aeaea8b4d88af3dc9f0989441969a5b7d50ece
MD5 e6ad8273a57e50a73deb37ba27836b69
BLAKE2b-256 5f5c610260eac4e3346cdddccf3f0910a02657552aacbf980a3d662bc4017753

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page