# OctoBot-Script [0.0.17](https://github.com/Drakkar-Software/OctoBot-Script/tree/master/CHANGELOG.md)
[](https://pypi.python.org/pypi/octobot-script/)
[](https://pepy.tech/project/octobot-script)
[](https://hub.docker.com/r/drakkarsoftware/octobot-script)
[](https://github.com/Drakkar-Software/OctoBot-Script/actions/workflows/main.yml)
## OctoBot-Script Community
[](https://octobot.click/readme-telegram-OctoBot-Script)
[](https://octobot.click/gh-discord-OctoBot-Script)
[](https://octobot.click/gh-twitter-OctoBot-Script)
## OctoBot Script is the Quant framework by OctoBot
> OctoBot Script is in alpha version
Documentation available at [octobot.cloud/en/guides/octobot-script](https://www.octobot.cloud/en/guides/octobot-script?utm_source=octobot&utm_medium=dk&utm_campaign=regular_open_source_content&utm_content=octobot_script_readme)
## Install OctoBot Script from pip
> OctoBot Script requires **Python 3.10**
``` {.sourceCode .bash}
python3 -m pip install OctoBot wheel
python3 -m pip install octobot-script
```
## Example of a backtesting script
### Script
``` python
import asyncio
import tulipy # Can be any TA library.
import octobot_script as obs
async def rsi_test():
async def strategy(ctx):
# Will be called at each candle.
if run_data["entries"] is None:
# Compute entries only once per backtest.
closes = await obs.Close(ctx, max_history=True)
times = await obs.Time(ctx, max_history=True, use_close_time=True)
rsi_v = tulipy.rsi(closes, period=ctx.tentacle.trading_config["period"])
delta = len(closes) - len(rsi_v)
# Populate entries with timestamps of candles where RSI is
# bellow the "rsi_value_buy_threshold" configuration.
run_data["entries"] = {
times[index + delta]
for index, rsi_val in enumerate(rsi_v)
if rsi_val < ctx.tentacle.trading_config["rsi_value_buy_threshold"]
}
await obs.plot_indicator(ctx, "RSI", times[delta:], rsi_v, run_data["entries"])
if obs.current_live_time(ctx) in run_data["entries"]:
# Uses pre-computed entries times to enter positions when relevant.
# Also, instantly set take profits and stop losses.
# Position exists could also be set separately.
await obs.market(ctx, "buy", amount="10%", stop_loss_offset="-15%", take_profit_offset="25%")
# Configuration that will be passed to each run.
# It will be accessible under "ctx.tentacle.trading_config".
config = {
"period": 10,
"rsi_value_buy_threshold": 28,
}
# Read and cache candle data to make subsequent backtesting runs faster.
data = await obs.get_data("BTC/USDT", "1d", start_timestamp=1505606400)
run_data = {
"entries": None,
}
# Run a backtest using the above data, strategy and configuration.
res = await obs.run(data, strategy, config)
print(res.describe())
# Generate and open report including indicators plots
await res.plot(show=True)
# Stop data to release local databases.
await data.stop()
# Call the execution of the script inside "asyncio.run" as
# OctoBot-Script runs using the python asyncio framework.
asyncio.run(rsi_test())
```
### Generated report
### Join the community
We recently created a telegram channel dedicated to OctoBot Script.
[](https://octobot.click/readme-telegram-OctoBot-Pro)
Raw data
{
"_id": null,
"home_page": "https://github.com/Drakkar-Software/OctoBot-Script",
"name": "OctoBot-Script",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Drakkar-Software",
"author_email": "contact@drakkar.software",
"download_url": "https://files.pythonhosted.org/packages/95/69/983bf38c15222e32cd9691e4fb14022947cf928f08c9776e995158eaeb88/OctoBot-Script-0.0.17.tar.gz",
"platform": null,
"description": "# OctoBot-Script [0.0.17](https://github.com/Drakkar-Software/OctoBot-Script/tree/master/CHANGELOG.md)\n[](https://pypi.python.org/pypi/octobot-script/)\n[](https://pepy.tech/project/octobot-script)\n[](https://hub.docker.com/r/drakkarsoftware/octobot-script)\n[](https://github.com/Drakkar-Software/OctoBot-Script/actions/workflows/main.yml)\n\n## OctoBot-Script Community\n[](https://octobot.click/readme-telegram-OctoBot-Script)\n[](https://octobot.click/gh-discord-OctoBot-Script)\n[](https://octobot.click/gh-twitter-OctoBot-Script)\n\n\n## OctoBot Script is the Quant framework by OctoBot\n\n> OctoBot Script is in alpha version\n\nDocumentation available at [octobot.cloud/en/guides/octobot-script](https://www.octobot.cloud/en/guides/octobot-script?utm_source=octobot&utm_medium=dk&utm_campaign=regular_open_source_content&utm_content=octobot_script_readme)\n\n\n## Install OctoBot Script from pip\n\n> OctoBot Script requires **Python 3.10**\n\n``` {.sourceCode .bash}\npython3 -m pip install OctoBot wheel\npython3 -m pip install octobot-script\n```\n\n## Example of a backtesting script\n\n### Script\n``` python\nimport asyncio\nimport tulipy # Can be any TA library.\nimport octobot_script as obs\n\n\nasync def rsi_test():\n async def strategy(ctx):\n # Will be called at each candle.\n if run_data[\"entries\"] is None:\n # Compute entries only once per backtest.\n closes = await obs.Close(ctx, max_history=True)\n times = await obs.Time(ctx, max_history=True, use_close_time=True)\n rsi_v = tulipy.rsi(closes, period=ctx.tentacle.trading_config[\"period\"])\n delta = len(closes) - len(rsi_v)\n # Populate entries with timestamps of candles where RSI is\n # bellow the \"rsi_value_buy_threshold\" configuration.\n run_data[\"entries\"] = {\n times[index + delta]\n for index, rsi_val in enumerate(rsi_v)\n if rsi_val < ctx.tentacle.trading_config[\"rsi_value_buy_threshold\"]\n }\n await obs.plot_indicator(ctx, \"RSI\", times[delta:], rsi_v, run_data[\"entries\"])\n if obs.current_live_time(ctx) in run_data[\"entries\"]:\n # Uses pre-computed entries times to enter positions when relevant.\n # Also, instantly set take profits and stop losses.\n # Position exists could also be set separately.\n await obs.market(ctx, \"buy\", amount=\"10%\", stop_loss_offset=\"-15%\", take_profit_offset=\"25%\")\n\n # Configuration that will be passed to each run.\n # It will be accessible under \"ctx.tentacle.trading_config\".\n config = {\n \"period\": 10,\n \"rsi_value_buy_threshold\": 28,\n }\n\n # Read and cache candle data to make subsequent backtesting runs faster.\n data = await obs.get_data(\"BTC/USDT\", \"1d\", start_timestamp=1505606400)\n run_data = {\n \"entries\": None,\n }\n # Run a backtest using the above data, strategy and configuration.\n res = await obs.run(data, strategy, config)\n print(res.describe())\n # Generate and open report including indicators plots \n await res.plot(show=True)\n # Stop data to release local databases.\n await data.stop()\n\n\n# Call the execution of the script inside \"asyncio.run\" as\n# OctoBot-Script runs using the python asyncio framework.\nasyncio.run(rsi_test())\n```\n\n### Generated report\n\n\n### Join the community\nWe recently created a telegram channel dedicated to OctoBot Script.\n\n[](https://octobot.click/readme-telegram-OctoBot-Pro)\n",
"bugtrack_url": null,
"license": "GPL-3.0",
"summary": "Backtesting framework of the OctoBot Ecosystem",
"version": "0.0.17",
"project_urls": {
"Homepage": "https://github.com/Drakkar-Software/OctoBot-Script"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9569983bf38c15222e32cd9691e4fb14022947cf928f08c9776e995158eaeb88",
"md5": "60d3c6b88a40c6e3e638d0674a50a705",
"sha256": "cafcbdd4d0f5cb28a51e66f823d5563e56fe806380187f7f975a663b6f232496"
},
"downloads": -1,
"filename": "OctoBot-Script-0.0.17.tar.gz",
"has_sig": false,
"md5_digest": "60d3c6b88a40c6e3e638d0674a50a705",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 36284,
"upload_time": "2024-05-01T20:12:23",
"upload_time_iso_8601": "2024-05-01T20:12:23.141839Z",
"url": "https://files.pythonhosted.org/packages/95/69/983bf38c15222e32cd9691e4fb14022947cf928f08c9776e995158eaeb88/OctoBot-Script-0.0.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-01 20:12:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Drakkar-Software",
"github_project": "OctoBot-Script",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "octobot-script"
}
JSON
