Metadata-Version: 2.4
Name: strategy_backtesting
Version: 0.2.0
Summary: Test your own strategies with python and a dataset. A hackclub siege project
Requires-Python: >=3.13
Description-Content-Type: text/markdown
Requires-Dist: matplotlib>=3.10.7
Requires-Dist: pandas>=2.3.3
Requires-Dist: websocket>=0.2.1

# PYTHON STRATEGY BACKTESTING
A cool Python backtesting tool.

### The idea
You load CSV chart data into the library, build your strategy on top of it and **SIMULATE** it! 🥳

## Installation
```bash
pip install strategy_backtesting
```

Install it with PIP and then **USE IT**!!

Keep in mind that all the CSV data need to follow this format:
```
timestamp,open,high,low,close,volume
```
where timestamp is in milliseconds and ordered from OLDEST to NEWEST.

## Example
To start, let's import the required libraries:

```python
import strategy_backtesting as sb
import pandas as pd
```

### After that we will define the settings for our simulation

**timespan** - The number of data points (e.g., 1000)

**buy_amount** - What the simulator will buy if triggered

**sell_amount** - What the simulator will sell if triggered

```python
settings = sb.Settings(timespan=1000, buy_amount=1, sell_amount=1)
```

Then we will create our chart object and apply the settings and CSV file (in this case the ETHUSDT chart data)
```python
eth_chart = sb.ChartManager()
eth_chart.set_chart_settings(settings=settings)
eth_chart.set_chart_data(pd.read_csv("ETHUSDT_1h.csv").iloc[::-1])
```


Then I will add my strategy, for example: Buying it only if the RSI is in cricial area
```python
buy_data = []
sell_data = []
oversold = 30
overbought = 70
for _, row in experiment_chart.iterrows():
    if not pd.notna(row["RSI"]):
        continue
    rsi = row["RSI"]
    if rsi < oversold:
        buy_data.append([row["timestamp"], row.get("close")])
    elif rsi > overbought:
        sell_data.append([row["timestamp"], row.get("close")])
```

Adding the strategy and simulating it

```python
strategy = sb.Strategy(name="RSI Strategy")
strategy.set_strategy_buys(buys=buy_data)
strategy.set_strategy_sells(sells=sell_data)

simulation = sb.Simulation(chart=experiment_chart, settings=settings, strategy=strategy)
portfolio = simulation.simulate()

print("TOTAL PnL: "+str(round((portfolio["balance"].iloc[-1])-settings.default_money, 2))+"$")

simulation.graph(rsi=True, rsi_over=[oversold, overbought], ema=True)
```

Now let's say we want to apply our strategy with a live chart. But we also need the websocket data
So let's initialize a session with:
```python
df = pd.DataFrame() # Used for the data displaying
url = 'wss://stream.binance.com:9443/ws/'
symbol = 'ethusdt'
stream = '@aggTrade'
long_url = url+symbol+stream
session = sb.Session(websocketURL=long_url, strategy=strategyFunction)
```

After we started the session with
```python
session.start()
```

But we also need a function that places our buy and sell marks:
```python
def strategyFunction(data):
    global df, simulated_assets, simulated_money
    # Here we receive price data and while its running we get the indicators so we add every entry to our strategy list
    append = {
        "timestamp": data['T'],
        "close": float(data['p']),
        "signal": None
    }
    
    new = pd.DataFrame([append])
    df = pd.concat([df, new], ignore_index=True)

    # Here you can add your own strategy and add signal: buy/sell depending on your strategy
```

we can define a live chart:

```python
# Wait till connection is available with websocket
time.sleep(3)

session.live_chart(
    df_getter=lambda: df, # DATAFRAME
    interval=0, # UPDATE INTERVAL
    max_p=10000, # MAX. DATA POINTS
    show_ema=True, # EMA LINES
    show_rsi=True, # RSI
    rsi_levels=[30, 70], # RSI, 30 LOW, 70 UP
    timeframe='1m' # TIMEFRAME
)

# KEEPING IT RUNNING
while(session.running):
    time.sleep(1)
```

FINISH! 🥳
