Skip to content

Repository files navigation

UsEquityStrategies

QSL architecture role

  • Layer: strategy-lib.
  • Responsibility: US equity strategy implementation package.
  • Owns: runtime-enabled US strategy code, manifests, execution metadata.
  • Consumes: QuantPlatformKit and validated US snapshot artifacts.
  • Must not: own broker credentials or deployment settings.

Chinese README

Investing involves risk. This project does not provide investment advice and is for education, research, and engineering review only.

What this repository is

UsEquityStrategies is the QuantStrategyLab US equity strategy package. It provides reusable strategy implementations and runtime metadata for QuantStrategyLab US equity platforms.

It is one layer of a multi-repository system:

  • Strategy packages: hold reusable strategy code, metadata, and runtime entrypoints.
  • Snapshot pipelines: produce feature snapshots, rankings, backtests, and release evidence.
  • Platform runtimes: connect strategies to brokers, dry-run checks, notifications, and live deployment controls.
  • Shared infrastructure: keeps contracts, settings, adapters, plugins, and audit workflows reusable across repositories.

This repository owns strategy code and metadata. It does not hold broker credentials, submit orders by itself, or replace the snapshot/backtest evidence required before a profile is enabled for live runtime settings.

Strategy profiles

Direct runtime strategies

These profiles can run from market history, portfolio snapshots, or other runtime inputs without a separate feature-snapshot build step.

ProfileNameNotes
tqqq_growth_incomeTQQQ Growth Incomeruntime-enabled QQQ/TQQQ dual-drive profile with defensive and income sleeves.
soxl_soxx_trend_incomeSOXL/SOXX Semiconductor Trend Incomeruntime-enabled semiconductor ETF trend profile.
nasdaq_sp500_smart_dcaNasdaq 100 / S&P 500 Smart DCAruntime-enabled buy-only DCA profile for broad US equity ETFs; defaults to monthly fixed-amount DCA with configurable weekly/monthly/quarterly cadence and optional smart sizing.
ibit_smart_dcaIBIT Smart DCAruntime-enabled buy-only spot Bitcoin ETF DCA profile; defaults to monthly fixed-amount DCA with configurable weekly/monthly/quarterly cadence and optional smart sizing.

Snapshot-backed strategies

These profiles depend on artifacts produced by UsEquitySnapshotPipelines before downstream platforms should use them.

ProfileNameNotes
global_etf_rotationGlobal ETF Rotationruntime-enabled feature-snapshot ETF rotation with daily canary defense and BIL safe haven.
russell_top50_leader_rotationRussell Top50 Leader Rotationruntime-enabled feature-snapshot Russell Top50 leader rotation.

Research-only candidates

Research-only profiles may stay in code for reproducibility and future review, but they should not appear in current configurable live profiles.

ProfileNameNotes
tech_communication_pullback_enhancementTech/Communication Pullback Enhancementarchived research-only; no longer a catalog/entrypoint runtime profile.

How this connects to execution

Execution platforms consume this package through strategy loaders and runtime metadata. Current downstream platforms: CharlesSchwabPlatform, InteractiveBrokersPlatform, LongBridgePlatform, and FirstradePlatform.

Use the platform repositories for broker credentials, dry-run/live switches, order submission, and deployment settings.

Evidence and live enablement

Use this README as a map of the project, not as live performance data. Before enabling or changing a live profile, rerun the relevant snapshot/backtest pipeline and review short, medium, and long windows: return, max drawdown, benchmark-relative return, turnover, data freshness, and artifact version. If evidence is stale, incomplete, or the profile is marked research-only, keep it out of live runtime settings.

Repository layout

  • src/: library and runtime code.
  • tests/: unit, contract, and regression tests.
  • docs/: runbooks, design notes, evidence, and integration contracts.
  • .github/workflows/: CI, scheduled jobs, release, or deployment workflows.

Quick start

python -m pip install -e .
python -m pytest -q

Useful docs

Safety and contribution notes

  • Keep secrets, account identifiers, tokens, cookies, and broker credentials out of Git and logs.
  • Prefer small, reviewable changes with tests or reproducible evidence.
  • For strategy changes, include the command or artifact used to validate behavior.

Community and security

  • See CONTRIBUTING.md for pull request scope, local verification, and documentation expectations.
  • Follow CODE_OF_CONDUCT.md for maintainer and contributor conduct.
  • Report credential, automation, broker, exchange, or cloud-resource vulnerabilities through SECURITY.md; do not open public issues for secrets or live-execution risk.

License

See LICENSE.

About

US equity strategy implementation package and runtime metadata for QuantStrategyLab.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages