tradelab 0.1.0 → 0.1.2

package/README.md

@@ -1,11 +1,12 @@
+<img src="https://i.imgur.com/HGvvQbq.png" width="500" alt="tradelab logo"/>
+
 # tradelab
 
 `tradelab` is a candle-based backtesting toolkit for Node.js. It is built for two use cases:
-
 - you already have candles and want a solid execution/backtest engine
 - you want to fetch Yahoo Finance data or import CSVs and backtest with minimal setup
 
-The package stays focused on historical research. It does not try to be a broker adapter or a live trading framework.
+The package stays focused on historical research and testing, and is not trying to be a broker adapter or a live trading framework. 
 
 ## Features
 
@@ -200,29 +201,6 @@ node examples/emaCross.js
 node examples/yahooEmaCross.js SPY 1d 1y
 ```
 
-## Local Scripts
-
-```bash
-npm run prefetch -- --symbol SPY --interval 1d --period 1y
-npm run import-csv -- ./data/sample.csv --symbol BTC-USD --interval 5m
-npm test
-```
-
-## Publishing
-
-Validate the package contents before publishing:
-
-```bash
-npm test
-npm pack --dry-run
-```
-
-Publish when the dry run looks correct:
-
-```bash
-npm publish
-```
-
 ## Notes
 
 - Yahoo downloads can be cached under `output/data` by default.

package/package.json

@@ -1,10 +1,18 @@
 {
   "name": "tradelab",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Reusable trading and backtesting engine for candle-based strategies",
   "type": "module",
   "main": "./src/index.js",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ishsharm0/tradelab.git"
+  },
+  "homepage": "https://github.com/ishsharm0/tradelab#readme",
+  "bugs": {
+    "url": "https://github.com/ishsharm0/tradelab/issues"
+  },
   "engines": {
     "node": ">=18"
   },
@@ -18,16 +26,11 @@
     "src",
     "templates",
     "examples/*.js",
-    "scripts",
     "README.md",
     "LICENSE"
   ],
   "scripts": {
-    "test": "node --test",
-    "prefetch": "node scripts/prefetch.js",
-    "import-csv": "node scripts/import-csv.js",
-    "example:ema": "node examples/emaCross.js",
-    "example:yahoo": "node examples/yahooEmaCross.js"
+    "test": "node --test"
   },
   "keywords": [
     "trading",

package/scripts/import-csv.js

@@ -1,69 +0,0 @@
-#!/usr/bin/env node
-
-import {
-  candleStats,
-  loadCandlesFromCSV,
-  saveCandlesToCache,
-} from "../src/index.js";
-
-function parseArgs(argv) {
-  const args = {};
-  for (let index = 0; index < argv.length; index += 1) {
-    const token = argv[index];
-    if (!token.startsWith("--")) {
-      if (!args.file) args.file = token;
-      continue;
-    }
-
-    const key = token.slice(2);
-    const next = argv[index + 1];
-    if (next && !next.startsWith("--")) {
-      args[key] = next;
-      index += 1;
-    } else {
-      args[key] = "true";
-    }
-  }
-  return args;
-}
-
-const args = parseArgs(process.argv.slice(2));
-
-if (!args.file || !args.symbol) {
-  console.log(
-    "Usage: node scripts/import-csv.js <file.csv> --symbol BTC-USD [--interval 5m] [--period 90d]"
-  );
-  process.exit(1);
-}
-
-try {
-  const candles = loadCandlesFromCSV(args.file, {
-    delimiter: args.delimiter || ",",
-    timeCol: args.timeCol || "time",
-    openCol: args.openCol || "open",
-    highCol: args.highCol || "high",
-    lowCol: args.lowCol || "low",
-    closeCol: args.closeCol || "close",
-    volumeCol: args.volumeCol || "volume",
-    startDate: args.startDate,
-    endDate: args.endDate,
-  });
-
-  const stats = candleStats(candles);
-  const interval = args.interval || "1d";
-  const period = args.period || `${Math.max(1, Math.ceil(stats?.durationDays || 1))}d`;
-  const outputPath = saveCandlesToCache(candles, {
-    symbol: args.symbol,
-    interval,
-    period,
-    outDir: args.outDir || "output/data",
-    source: "csv",
-  });
-
-  console.log(`Loaded ${stats?.count ?? 0} candles`);
-  console.log(`Range: ${stats?.firstTime ?? "—"} -> ${stats?.lastTime ?? "—"}`);
-  console.log(`Saved cache: ${outputPath}`);
-} catch (error) {
-  console.error(error.message);
-  process.exit(1);
-}

package/scripts/prefetch.js

@@ -1,52 +0,0 @@
-#!/usr/bin/env node
-
-import { getHistoricalCandles, saveCandlesToCache } from "../src/index.js";
-
-function parseArgs(argv) {
-  const args = {};
-  for (let index = 0; index < argv.length; index += 1) {
-    const token = argv[index];
-    if (!token.startsWith("--")) continue;
-
-    const key = token.slice(2);
-    const next = argv[index + 1];
-    if (next && !next.startsWith("--")) {
-      args[key] = next;
-      index += 1;
-    } else {
-      args[key] = "true";
-    }
-  }
-  return args;
-}
-
-const args = parseArgs(process.argv.slice(2));
-const symbol = args.symbol || "SPY";
-const interval = args.interval || "1d";
-const period = args.period || "1y";
-const outDir = args.outDir || "output/data";
-
-async function main() {
-  const candles = await getHistoricalCandles({
-    source: "yahoo",
-    symbol,
-    interval,
-    period,
-    cache: false,
-  });
-
-  const outputPath = saveCandlesToCache(candles, {
-    symbol,
-    interval,
-    period,
-    outDir,
-    source: "yahoo",
-  });
-
-  console.log(`Saved ${candles.length} candles to ${outputPath}`);
-}
-
-main().catch((error) => {
-  console.error(error.message);
-  process.exit(1);
-});