Metadata-Version: 2.3
Name: ziplime
Version: 0.1.18
Summary: 
Author: Ziplime
Requires-Python: >=3.12,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: dask (>=2024.9.1,<2025.0.0)
Requires-Dist: joblib (>=1.4.2,<2.0.0)
Requires-Dist: lime-trader-sdk (>=0.3.9,<0.4.0)
Requires-Dist: limexhub (>=0.1.27,<0.2.0)
Requires-Dist: pygments (>=2.18.0,<3.0.0)
Requires-Dist: setuptools (>=72.1.0,<73.0.0)
Requires-Dist: zipline-reloaded (==3.1)
Description-Content-Type: text/markdown

# ziplime

Zipline wrapper which enables using Lime data for backtesting

## Installation

```Bash
poetry add ziplime
```

## Usage

You can find usage examples below. All commands supported by `zipline` are also supported by `ziplime` with extended
list of parameters for easier usage.

### Data ingestion

Data ingestion works by first fetching historical data and then and then running live data fetch in the background. 

Difference from original zipline:

- `--start-date` and `--end-date` parameters - used to fetch bundle data only for specific date period
- `--symbols` parameter - specifies symbols to fetch data for directly in the command
- Running live data fetch in the background

Example:

Ingest data:
```Bash
poetry run python -m ziplime ingest -b lime --period day --start-date 2024-06-01 --end-date 2024-07-31 --symbols AAPL,TSLA,AMZN
```
Run strategy
```Bash
poetry run python -m ziplime run -b lime --start 2024-06-01 --end 2024-07-31 --data-frequency daily --capital-base 100000 --no-benchmark -f test.py
```

Run live trade (still in development)
```Bash
run -b lime --start 2024-12-01 --end 2024-12-31 --data-frequency daily --capital-base 100000 --no-benchmark --broker lime-trader-sdk -f test_live_trade.py --print-algo
```


