Rename from OctoBot Pro to OctoBot Script

Author: Herklos

.github/workflows/docker.yml

@@ -1,4 +1,4 @@
-name: OctoBot-Pro - Docker
+name: OctoBot-Script - Docker
 on:
   push:
     branches:
@@ -31,7 +31,7 @@ jobs:
       - name: Set Environment Variables
         run: |
           OWNER="$(echo "${{ github.repository_owner }}" | tr '[:upper:]' '[:lower:]' | tr -d '-')"
-          IMG=octobot-pro
+          IMG=octobot-script
           echo "VERSION=${GITHUB_REF##*/}" >> $GITHUB_ENV
           echo "IMAGE=${OWNER}/${IMG}" >> $GITHUB_ENV
           echo "LATEST=latest" >> $GITHUB_ENV

.github/workflows/main.yml

@@ -1,4 +1,4 @@
-name: OctoBot-Pro - CI
+name: OctoBot-Script - CI
 on:
   push:
     branches:
@@ -11,7 +11,7 @@ jobs:
   lint:
     uses: Drakkar-Software/.github/.github/workflows/python3_lint_workflow.yml@master
     with:
-      project_main_package: octobot_pro
+      project_main_package: octobot_script
 
   tests:
     name: ${{ matrix.os }} - Python - ${{ matrix.type }} - tests

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
+## [0.0.13] - 2023-10-09
+### Updated
+- Renamed from OctoBot Pro to OctoBot Script
+
 ## [0.0.12] - 2023-09-27
 ### Added
 - Dockerfile

Dockerfile

@@ -1,6 +1,6 @@
 FROM python:3.10-slim-buster AS base
 
-WORKDIR /pro
+WORKDIR /app
 
 # requires git to install requirements with git+https
 RUN apt-get update \

MANIFEST.in

@@ -1,5 +1,5 @@
-recursive-include octobot_pro/config *.json *.ini
-recursive-include octobot_pro/resources *.js *.css *.html
+recursive-include octobot_script/config *.json *.ini
+recursive-include octobot_script/resources *.js *.css *.html
 
 include README.md
 include LICENSE

README.md

@@ -1,29 +1,29 @@
-# Octobot-Pro [0.0.12](https://github.com/Drakkar-Software/OctoBot-Pro/tree/master/CHANGELOG.md)
-[![PyPI](https://img.shields.io/pypi/v/octobot-pro.svg?logo=pypi)](https://pypi.python.org/pypi/octobot-pro/)
-[![Downloads](https://static.pepy.tech/badge/octobot-pro/month)](https://pepy.tech/project/octobot-pro)
-[![Dockerhub](https://img.shields.io/docker/pulls/drakkarsoftware/octobot-pro.svg?logo=docker)](https://hub.docker.com/r/drakkarsoftware/octobot-pro)
-[![Github-Action-CI](https://github.com/Drakkar-Software/OctoBot-Pro/workflows/OctoBot-Pro-CI/badge.svg)](https://github.com/Drakkar-Software/OctoBot-Pro/actions)
+# OctoBot-Script [0.0.12](https://github.com/Drakkar-Software/OctoBot-Script/tree/master/CHANGELOG.md)
+[![PyPI](https://img.shields.io/pypi/v/OctoBot-Script.svg?logo=pypi)](https://pypi.python.org/pypi/OctoBot-Script/)
+[![Downloads](https://static.pepy.tech/badge/OctoBot-Script/month)](https://pepy.tech/project/OctoBot-Script)
+[![Dockerhub](https://img.shields.io/docker/pulls/drakkarsoftware/OctoBot-Script.svg?logo=docker)](https://hub.docker.com/r/drakkarsoftware/OctoBot-Script)
+[![Github-Action-CI](https://github.com/Drakkar-Software/OctoBot-Script/workflows/OctoBot-Script-CI/badge.svg)](https://github.com/Drakkar-Software/OctoBot-Script/actions)
 
-## Octobot-Pro Community
-[![Telegram Chat](https://img.shields.io/badge/telegram-chat-green.svg?logo=telegram&label=Telegram)](https://octobot.click/readme-telegram-octobot-pro)
-[![Discord](https://img.shields.io/discord/530629985661222912.svg?logo=discord&label=Discord)](https://octobot.click/gh-discord-octobot-pro)
-[![Twitter](https://img.shields.io/twitter/follow/DrakkarsOctobot.svg?label=twitter&style=social)](https://octobot.click/gh-twitter-octobot-pro)
+## OctoBot-Script Community
+[![Telegram Chat](https://img.shields.io/badge/telegram-chat-green.svg?logo=telegram&label=Telegram)](https://octobot.click/readme-telegram-OctoBot-Script)
+[![Discord](https://img.shields.io/discord/530629985661222912.svg?logo=discord&label=Discord)](https://octobot.click/gh-discord-OctoBot-Script)
+[![Twitter](https://img.shields.io/twitter/follow/DrakkarsOctobot.svg?label=twitter&style=social)](https://octobot.click/gh-twitter-OctoBot-Script)
 
 
-## OctoBot Pro is the backtesting framework using the OctoBot Ecosystem
+## OctoBot Script is the backtesting framework using the OctoBot Ecosystem
 
-> OctoBot Pro is in early alpha version
+> OctoBot Script is in early alpha version
 
 Documentation available at [https://pro.octobot.info/](https://octobot.click/Xzae1a6)
 
 
-## Install OctoBot Pro from pip
+## Install OctoBot Script from pip
 
-> OctoBot pro requires **Python 3.10**
+> OctoBot Script requires **Python 3.10**
 
 ``` {.sourceCode .bash}
 python3 -m pip install OctoBot wheel
-python3 -m pip install octobot-pro
+python3 -m pip install octobot-script
 ```
 
 ## Example of a backtesting script
@@ -32,7 +32,7 @@ python3 -m pip install octobot-pro
 ``` python
 import asyncio
 import tulipy    # Can be any TA library.
-import octobot_pro as op
+import octobot_script as op
 
 
 async def rsi_test():
@@ -80,14 +80,14 @@ async def rsi_test():
 
 
 # Call the execution of the script inside "asyncio.run" as
-# OctoBot-Pro runs using the python asyncio framework.
+# OctoBot-Script runs using the python asyncio framework.
 asyncio.run(rsi_test())
 ```
 
 ### Generated report
-![report-p1](https://raw.githubusercontent.com/Drakkar-Software/OctoBot-Pro/assets/images/report_1.jpg)
+![report-p1](https://raw.githubusercontent.com/Drakkar-Software/OctoBot-Script/assets/images/report_1.jpg)
 
 ### Join the community
-We recently created a telegram channel dedicated to OctoBot Pro.
+We recently created a telegram channel dedicated to OctoBot Script.
 
-[![Telegram News](https://img.shields.io/static/v1?label=Telegram%20chat&message=Join&logo=telegram&&color=007bff&style=for-the-badge)](https://octobot.click/readme-telegram-octobot-pro)
+[![Telegram News](https://img.shields.io/static/v1?label=Telegram%20chat&message=Join&logo=telegram&&color=007bff&style=for-the-badge)](https://octobot.click/readme-telegram-OctoBot-Pro)

ai-example.py

@@ -8,7 +8,7 @@
 import argparse
 
 import octobot_commons.symbols as symbols
-import octobot_pro as op
+import octobot_script as op
 
 async def basic_evaluation_function(ctx):
     closes = await op.Close(ctx, max_history=True)

docs/data/fetching_data.md

@@ -1,10 +1,10 @@
 # Fetching trading data
 
-In order to run a backtest, OctoBot-Pro requires historical 
+In order to run a backtest, OctoBot-Script requires historical 
 trading data, which is at least candles history.
 
 ## Fetching new data
-When using OctoBot-Pro, historical data can be fetched using:
+When using OctoBot-Script, historical data can be fetched using:
 `await op.get_data(symbol, time frame)`
 
 Where:

docs/strategies/basis.md

@@ -1,6 +1,6 @@
-# OctoBot-Pro strategies
+# OctoBot-Script strategies
 
-On OctoBot-Pro, a trading strategy is a python async function that will be called at new price data.
+On OctoBot-Script, a trading strategy is a python async function that will be called at new price data.
 ``` python
 async def strategy(ctx):
     # your strategy content
@@ -12,7 +12,7 @@ In most cases, a strategy will:
 3. Decide to take (or not take) action depending on its configuration 
 4. Create / cancel or edit orders (see [Creating orders](../../docs/trading/orders.md))
 
-As OctoBot-Pro strategies are meant for backtesting, it is possible to create a strategy in 2 ways:
+As OctoBot-Script strategies are meant for backtesting, it is possible to create a strategy in 2 ways:
 ## Pre-computed strategies
 Pre-computed are only possible in backtesting: since the data is already known, when dealing with technical 
 evaluator based strategies, it is possible to compute the values of the evaluators for the whole backtest at once. 

example.py

@@ -1,6 +1,6 @@
 import asyncio
 import tulipy    # Can be any TA library.
-import octobot_pro as op
+import octobot_script as op
 
 
 async def rsi_test():
@@ -48,5 +48,5 @@ async def strategy(ctx):
 
 
 # Call the execution of the script inside "asyncio.run" as
-# OctoBot-Pro runs using the python asyncio framework.
+# OctoBot-Script runs using the python asyncio framework.
 asyncio.run(rsi_test())

octobot_pro/ai/__init__.py

@@ -1,4 +1,4 @@
-#  This file is part of OctoBot-Pro (https://github.com/Drakkar-Software/OctoBot-Pro)
+#  This file is part of OctoBot-Script (https://github.com/Drakkar-Software/OctoBot-Script)
 #  Copyright (c) 2023 Drakkar-Software, All rights reserved.
 #
 #  OctoBot is free software; you can redistribute it and/or
@@ -12,19 +12,19 @@
 #  General Public License for more details.
 #
 #  You should have received a copy of the GNU General Public
-#  License along with OctoBot-Pro. If not, see <https://www.gnu.org/licenses/>.
+#  License along with OctoBot-Script. If not, see <https://www.gnu.org/licenses/>.
 
-PROJECT_NAME = "OctoBot-Pro"
+PROJECT_NAME = "OctoBot-Script"
 AUTHOR = "Drakkar-Software"
-VERSION = "0.0.12"  # major.minor.revision
+VERSION = "0.0.13"  # major.minor.revision
 
 
 def _use_module_local_tentacles():
     import sys
     import os
     import appdirs
     if os.getenv("USE_CUSTOM_TENTACLES", "").lower() == "true":
-        # do not use octobot_pro/imports tentacles
+        # do not use octobot_script/imports tentacles
         # WARNING: in this case, all the required tentacles imports still have to work
         # and therefore be bound to another tentacles folder
         return
@@ -34,15 +34,15 @@ def _use_module_local_tentacles():
     sys.path.insert(0, internal_import_path)
 
 
-# run this before any other code as only octobot_pro module-local tentacles should be used
+# run this before any other code as only octobot_script module-local tentacles should be used
 _use_module_local_tentacles()
 
 try:
-    # import tentacles from octobot_pro/imports directory after "_use_local_tentacles()" call
+    # import tentacles from octobot_script/imports directory after "_use_local_tentacles()" call
     from tentacles.Meta.Keywords import *
     # populate tentacles config helpers
     import octobot_tentacles_manager.loaders as loaders
-    import octobot_pro.internal.octobot_mocks as octobot_mocks
+    import octobot_script.internal.octobot_mocks as octobot_mocks
     loaders.reload_tentacle_by_tentacle_class(
         tentacles_path=octobot_mocks.get_imported_tentacles_path()
     )
@@ -53,7 +53,7 @@ def _use_module_local_tentacles():
     # tentacles not available during first install
     pass
 
-from octobot_pro.constants import *
-from octobot_pro.api import *
-from octobot_pro.model import *
-from octobot_pro.ai import *
+from octobot_script.constants import *
+from octobot_script.api import *
+from octobot_script.model import *
+from octobot_script.ai import *

octobot_pro/__init__.py renamed to octobot_script/__init__.py

@@ -0,0 +1,14 @@
+try:
+    from octobot_script.ai.environments import *
+    from octobot_script.ai.models import *
+    from octobot_script.ai.agents import *
+
+    from gymnasium.envs.registration import register
+
+    register(
+        id='TradingEnv',
+        entry_point='octobot_script.ai.environments:TradingEnv',
+        disable_env_checker = True
+    )
+except ImportError:
+    pass

octobot_script/ai/__init__.py

@@ -2,7 +2,7 @@
 import random
 import numpy as np
 
-from octobot_pro.ai.models import mlp
+from octobot_script.ai.models import mlp
 
 class DQNAgent:
     def __init__(self, action_size):

octobot_pro/ai/agents.py renamed to octobot_script/ai/agents.py

@@ -3,7 +3,7 @@
 from gymnasium import spaces
 import numpy as np
 
-import octobot_pro as op
+import octobot_script as op
 import octobot_trading.errors as octobot_trading_errors
 import octobot_trading.api as trading_api
 

octobot_pro/ai/environments.py renamed to octobot_script/ai/environments.py

@@ -1,4 +1,4 @@
-#  This file is part of OctoBot-Pro (https://github.com/Drakkar-Software/OctoBot-Pro)
+#  This file is part of OctoBot-Script (https://github.com/Drakkar-Software/OctoBot-Script)
 #  Copyright (c) 2023 Drakkar-Software, All rights reserved.
 #
 #  OctoBot is free software; you can redistribute it and/or
@@ -12,9 +12,9 @@
 #  General Public License for more details.
 #
 #  You should have received a copy of the GNU General Public
-#  License along with OctoBot-Pro. If not, see <https://www.gnu.org/licenses/>.
+#  License along with OctoBot-Script. If not, see <https://www.gnu.org/licenses/>.
 
 
-from octobot_pro.api.data_fetching import *
-from octobot_pro.api.execution import *
-from octobot_pro.api.ploting import *
+from octobot_script.api.data_fetching import *
+from octobot_script.api.execution import *
+from octobot_script.api.ploting import *

octobot_pro/ai/models.py renamed to octobot_script/ai/models.py

@@ -1,4 +1,4 @@
-#  This file is part of OctoBot-Pro (https://github.com/Drakkar-Software/OctoBot-Pro)
+#  This file is part of OctoBot-Script (https://github.com/Drakkar-Software/OctoBot-Script)
 #  Copyright (c) 2023 Drakkar-Software, All rights reserved.
 #
 #  OctoBot is free software; you can redistribute it and/or
@@ -12,13 +12,13 @@
 #  General Public License for more details.
 #
 #  You should have received a copy of the GNU General Public
-#  License along with OctoBot-Pro. If not, see <https://www.gnu.org/licenses/>.
+#  License along with OctoBot-Script. If not, see <https://www.gnu.org/licenses/>.
 
 import octobot_backtesting.api as backtesting_api
 import octobot_commons.symbols as commons_symbols
 import octobot_commons.enums as commons_enums
 import octobot_trading.enums as trading_enums
-import octobot_pro.internal.octobot_mocks as octobot_mocks
+import octobot_script.internal.octobot_mocks as octobot_mocks
 
 
 def _ensure_ms_timestamp(timestamp):

octobot_pro/api/__init__.py renamed to octobot_script/api/__init__.py

@@ -1,4 +1,4 @@
-#  This file is part of OctoBot-Pro (https://github.com/Drakkar-Software/OctoBot-Pro)
+#  This file is part of OctoBot-Script (https://github.com/Drakkar-Software/OctoBot-Script)
 #  Copyright (c) 2023 Drakkar-Software, All rights reserved.
 #
 #  OctoBot is free software; you can redistribute it and/or
@@ -12,10 +12,10 @@
 #  General Public License for more details.
 #
 #  You should have received a copy of the GNU General Public
-#  License along with OctoBot-Pro. If not, see <https://www.gnu.org/licenses/>.
+#  License along with OctoBot-Script. If not, see <https://www.gnu.org/licenses/>.
 
-import octobot_pro.internal.logging_util as logging_util
-import octobot_pro.internal.runners as runners
+import octobot_script.internal.logging_util as logging_util
+import octobot_script.internal.runners as runners
 
 
 async def run(backtesting_data, update_func, strategy_config,

octobot_pro/api/data_fetching.py renamed to octobot_script/api/data_fetching.py

@@ -1,5 +1,5 @@
 # pylint: disable=E1101
-#  This file is part of OctoBot-Pro (https://github.com/Drakkar-Software/OctoBot-Pro)
+#  This file is part of OctoBot-Script (https://github.com/Drakkar-Software/OctoBot-Script)
 #  Copyright (c) 2023 Drakkar-Software, All rights reserved.
 #
 #  OctoBot is free software; you can redistribute it and/or
@@ -13,11 +13,11 @@
 #  General Public License for more details.
 #
 #  You should have received a copy of the GNU General Public
-#  License along with OctoBot-Pro. If not, see <https://www.gnu.org/licenses/>.
+#  License along with OctoBot-Script. If not, see <https://www.gnu.org/licenses/>.
 
 async def plot_indicator(ctx, name, x, y, signals=None):
     # lazy import
-    import octobot_pro as op
+    import octobot_script as op
 
     await op.plot(ctx, name, x=list(x), y=list(y))
     value_by_x = {