From 64ecd35f58689e8ec34f9c9c7c5afc3d7652404f Mon Sep 17 00:00:00 2001 From: Tyler Simpson Date: Sat, 22 Jun 2024 21:01:00 +0000 Subject: [PATCH] Deployed 79ef2a5 with MkDocs version: 1.6.0 --- docs/api_reference.md => .nojekyll | 0 site/404.html => 404.html | 0 .../index.html | 0 {site/assets => assets}/images/favicon.png | Bin .../javascripts/bundle.ad660dcc.min.js | 0 .../javascripts/bundle.ad660dcc.min.js.map | 0 .../javascripts/lunr/min/lunr.ar.min.js | 0 .../javascripts/lunr/min/lunr.da.min.js | 0 .../javascripts/lunr/min/lunr.de.min.js | 0 .../javascripts/lunr/min/lunr.du.min.js | 0 .../javascripts/lunr/min/lunr.el.min.js | 0 .../javascripts/lunr/min/lunr.es.min.js | 0 .../javascripts/lunr/min/lunr.fi.min.js | 0 .../javascripts/lunr/min/lunr.fr.min.js | 0 .../javascripts/lunr/min/lunr.he.min.js | 0 .../javascripts/lunr/min/lunr.hi.min.js | 0 .../javascripts/lunr/min/lunr.hu.min.js | 0 .../javascripts/lunr/min/lunr.hy.min.js | 0 .../javascripts/lunr/min/lunr.it.min.js | 0 .../javascripts/lunr/min/lunr.ja.min.js | 0 .../javascripts/lunr/min/lunr.jp.min.js | 0 .../javascripts/lunr/min/lunr.kn.min.js | 0 .../javascripts/lunr/min/lunr.ko.min.js | 0 .../javascripts/lunr/min/lunr.multi.min.js | 0 .../javascripts/lunr/min/lunr.nl.min.js | 0 .../javascripts/lunr/min/lunr.no.min.js | 0 .../javascripts/lunr/min/lunr.pt.min.js | 0 .../javascripts/lunr/min/lunr.ro.min.js | 0 .../javascripts/lunr/min/lunr.ru.min.js | 0 .../javascripts/lunr/min/lunr.sa.min.js | 0 .../lunr/min/lunr.stemmer.support.min.js | 0 .../javascripts/lunr/min/lunr.sv.min.js | 0 .../javascripts/lunr/min/lunr.ta.min.js | 0 .../javascripts/lunr/min/lunr.te.min.js | 0 .../javascripts/lunr/min/lunr.th.min.js | 0 .../javascripts/lunr/min/lunr.tr.min.js | 0 .../javascripts/lunr/min/lunr.vi.min.js | 0 .../javascripts/lunr/min/lunr.zh.min.js | 0 .../javascripts/lunr/tinyseg.js | 0 .../javascripts/lunr/wordcut.js | 0 .../workers/search.b8dbb3d2.min.js | 0 .../workers/search.b8dbb3d2.min.js.map | 0 .../stylesheets/main.6543a935.min.css | 0 .../stylesheets/main.6543a935.min.css.map | 0 .../stylesheets/palette.06af60db.min.css | 0 .../stylesheets/palette.06af60db.min.css.map | 0 .../index.html | 246 +++++++++++++++++- {site/docker => docker}/index.html | 0 docs/configuration.md | 0 docs/docker.md | 0 docs/index.md | 3 - docs/installation.md | 95 ------- docs/strategies.md | 0 docs/telegram_alerts.md | 0 docs/usage.md | 0 site/index.html => index.html | 0 .../installation => installation}/index.html | 0 mkdocs.yml | 21 -- search/search_index.json | 1 + site/search/search_index.json | 1 - site/sitemap.xml => sitemap.xml | 0 site/sitemap.xml.gz => sitemap.xml.gz | Bin {site/strategies => strategies}/index.html | 0 .../index.html | 0 {site/usage => usage}/index.html | 0 65 files changed, 244 insertions(+), 123 deletions(-) rename docs/api_reference.md => .nojekyll (100%) rename site/404.html => 404.html (100%) rename {site/api_reference => api_reference}/index.html (100%) rename {site/assets => assets}/images/favicon.png (100%) rename {site/assets => assets}/javascripts/bundle.ad660dcc.min.js (100%) rename {site/assets => assets}/javascripts/bundle.ad660dcc.min.js.map (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.ar.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.da.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.de.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.du.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.el.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.es.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.fi.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.fr.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.he.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.hi.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.hu.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.hy.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.it.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.ja.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.jp.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.kn.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.ko.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.multi.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.nl.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.no.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.pt.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.ro.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.ru.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.sa.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.stemmer.support.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.sv.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.ta.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.te.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.th.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.tr.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.vi.min.js (100%) rename {site/assets => assets}/javascripts/lunr/min/lunr.zh.min.js (100%) rename {site/assets => assets}/javascripts/lunr/tinyseg.js (100%) rename {site/assets => assets}/javascripts/lunr/wordcut.js (100%) rename {site/assets => assets}/javascripts/workers/search.b8dbb3d2.min.js (100%) rename {site/assets => assets}/javascripts/workers/search.b8dbb3d2.min.js.map (100%) rename {site/assets => assets}/stylesheets/main.6543a935.min.css (100%) rename {site/assets => assets}/stylesheets/main.6543a935.min.css.map (100%) rename {site/assets => assets}/stylesheets/palette.06af60db.min.css (100%) rename {site/assets => assets}/stylesheets/palette.06af60db.min.css.map (100%) rename {site/configuration => configuration}/index.html (56%) rename {site/docker => docker}/index.html (100%) delete mode 100644 docs/configuration.md delete mode 100644 docs/docker.md delete mode 100644 docs/index.md delete mode 100644 docs/installation.md delete mode 100644 docs/strategies.md delete mode 100644 docs/telegram_alerts.md delete mode 100644 docs/usage.md rename site/index.html => index.html (100%) rename {site/installation => installation}/index.html (100%) delete mode 100644 mkdocs.yml create mode 100644 search/search_index.json delete mode 100644 site/search/search_index.json rename site/sitemap.xml => sitemap.xml (100%) rename site/sitemap.xml.gz => sitemap.xml.gz (100%) rename {site/strategies => strategies}/index.html (100%) rename {site/telegram_alerts => telegram_alerts}/index.html (100%) rename {site/usage => usage}/index.html (100%) diff --git a/docs/api_reference.md b/.nojekyll similarity index 100% rename from docs/api_reference.md rename to .nojekyll diff --git a/site/404.html b/404.html similarity index 100% rename from site/404.html rename to 404.html diff --git a/site/api_reference/index.html b/api_reference/index.html similarity index 100% rename from site/api_reference/index.html rename to api_reference/index.html diff --git a/site/assets/images/favicon.png b/assets/images/favicon.png similarity index 100% rename from site/assets/images/favicon.png rename to assets/images/favicon.png diff --git a/site/assets/javascripts/bundle.ad660dcc.min.js b/assets/javascripts/bundle.ad660dcc.min.js similarity index 100% rename from site/assets/javascripts/bundle.ad660dcc.min.js rename to assets/javascripts/bundle.ad660dcc.min.js diff --git a/site/assets/javascripts/bundle.ad660dcc.min.js.map b/assets/javascripts/bundle.ad660dcc.min.js.map similarity index 100% rename from site/assets/javascripts/bundle.ad660dcc.min.js.map rename to assets/javascripts/bundle.ad660dcc.min.js.map diff --git a/site/assets/javascripts/lunr/min/lunr.ar.min.js b/assets/javascripts/lunr/min/lunr.ar.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.ar.min.js rename to assets/javascripts/lunr/min/lunr.ar.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.da.min.js b/assets/javascripts/lunr/min/lunr.da.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.da.min.js rename to assets/javascripts/lunr/min/lunr.da.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.de.min.js b/assets/javascripts/lunr/min/lunr.de.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.de.min.js rename to assets/javascripts/lunr/min/lunr.de.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.du.min.js b/assets/javascripts/lunr/min/lunr.du.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.du.min.js rename to assets/javascripts/lunr/min/lunr.du.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.el.min.js b/assets/javascripts/lunr/min/lunr.el.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.el.min.js rename to assets/javascripts/lunr/min/lunr.el.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.es.min.js b/assets/javascripts/lunr/min/lunr.es.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.es.min.js rename to assets/javascripts/lunr/min/lunr.es.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.fi.min.js b/assets/javascripts/lunr/min/lunr.fi.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.fi.min.js rename to assets/javascripts/lunr/min/lunr.fi.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.fr.min.js b/assets/javascripts/lunr/min/lunr.fr.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.fr.min.js rename to assets/javascripts/lunr/min/lunr.fr.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.he.min.js b/assets/javascripts/lunr/min/lunr.he.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.he.min.js rename to assets/javascripts/lunr/min/lunr.he.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.hi.min.js b/assets/javascripts/lunr/min/lunr.hi.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.hi.min.js rename to assets/javascripts/lunr/min/lunr.hi.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.hu.min.js b/assets/javascripts/lunr/min/lunr.hu.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.hu.min.js rename to assets/javascripts/lunr/min/lunr.hu.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.hy.min.js b/assets/javascripts/lunr/min/lunr.hy.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.hy.min.js rename to assets/javascripts/lunr/min/lunr.hy.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.it.min.js b/assets/javascripts/lunr/min/lunr.it.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.it.min.js rename to assets/javascripts/lunr/min/lunr.it.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.ja.min.js b/assets/javascripts/lunr/min/lunr.ja.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.ja.min.js rename to assets/javascripts/lunr/min/lunr.ja.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.jp.min.js b/assets/javascripts/lunr/min/lunr.jp.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.jp.min.js rename to assets/javascripts/lunr/min/lunr.jp.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.kn.min.js b/assets/javascripts/lunr/min/lunr.kn.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.kn.min.js rename to assets/javascripts/lunr/min/lunr.kn.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.ko.min.js b/assets/javascripts/lunr/min/lunr.ko.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.ko.min.js rename to assets/javascripts/lunr/min/lunr.ko.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.multi.min.js b/assets/javascripts/lunr/min/lunr.multi.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.multi.min.js rename to assets/javascripts/lunr/min/lunr.multi.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.nl.min.js b/assets/javascripts/lunr/min/lunr.nl.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.nl.min.js rename to assets/javascripts/lunr/min/lunr.nl.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.no.min.js b/assets/javascripts/lunr/min/lunr.no.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.no.min.js rename to assets/javascripts/lunr/min/lunr.no.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.pt.min.js b/assets/javascripts/lunr/min/lunr.pt.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.pt.min.js rename to assets/javascripts/lunr/min/lunr.pt.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.ro.min.js b/assets/javascripts/lunr/min/lunr.ro.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.ro.min.js rename to assets/javascripts/lunr/min/lunr.ro.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.ru.min.js b/assets/javascripts/lunr/min/lunr.ru.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.ru.min.js rename to assets/javascripts/lunr/min/lunr.ru.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.sa.min.js b/assets/javascripts/lunr/min/lunr.sa.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.sa.min.js rename to assets/javascripts/lunr/min/lunr.sa.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.stemmer.support.min.js b/assets/javascripts/lunr/min/lunr.stemmer.support.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.stemmer.support.min.js rename to assets/javascripts/lunr/min/lunr.stemmer.support.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.sv.min.js b/assets/javascripts/lunr/min/lunr.sv.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.sv.min.js rename to assets/javascripts/lunr/min/lunr.sv.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.ta.min.js b/assets/javascripts/lunr/min/lunr.ta.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.ta.min.js rename to assets/javascripts/lunr/min/lunr.ta.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.te.min.js b/assets/javascripts/lunr/min/lunr.te.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.te.min.js rename to assets/javascripts/lunr/min/lunr.te.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.th.min.js b/assets/javascripts/lunr/min/lunr.th.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.th.min.js rename to assets/javascripts/lunr/min/lunr.th.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.tr.min.js b/assets/javascripts/lunr/min/lunr.tr.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.tr.min.js rename to assets/javascripts/lunr/min/lunr.tr.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.vi.min.js b/assets/javascripts/lunr/min/lunr.vi.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.vi.min.js rename to assets/javascripts/lunr/min/lunr.vi.min.js diff --git a/site/assets/javascripts/lunr/min/lunr.zh.min.js b/assets/javascripts/lunr/min/lunr.zh.min.js similarity index 100% rename from site/assets/javascripts/lunr/min/lunr.zh.min.js rename to assets/javascripts/lunr/min/lunr.zh.min.js diff --git a/site/assets/javascripts/lunr/tinyseg.js b/assets/javascripts/lunr/tinyseg.js similarity index 100% rename from site/assets/javascripts/lunr/tinyseg.js rename to assets/javascripts/lunr/tinyseg.js diff --git a/site/assets/javascripts/lunr/wordcut.js b/assets/javascripts/lunr/wordcut.js similarity index 100% rename from site/assets/javascripts/lunr/wordcut.js rename to assets/javascripts/lunr/wordcut.js diff --git a/site/assets/javascripts/workers/search.b8dbb3d2.min.js b/assets/javascripts/workers/search.b8dbb3d2.min.js similarity index 100% rename from site/assets/javascripts/workers/search.b8dbb3d2.min.js rename to assets/javascripts/workers/search.b8dbb3d2.min.js diff --git a/site/assets/javascripts/workers/search.b8dbb3d2.min.js.map b/assets/javascripts/workers/search.b8dbb3d2.min.js.map similarity index 100% rename from site/assets/javascripts/workers/search.b8dbb3d2.min.js.map rename to assets/javascripts/workers/search.b8dbb3d2.min.js.map diff --git a/site/assets/stylesheets/main.6543a935.min.css b/assets/stylesheets/main.6543a935.min.css similarity index 100% rename from site/assets/stylesheets/main.6543a935.min.css rename to assets/stylesheets/main.6543a935.min.css diff --git a/site/assets/stylesheets/main.6543a935.min.css.map b/assets/stylesheets/main.6543a935.min.css.map similarity index 100% rename from site/assets/stylesheets/main.6543a935.min.css.map rename to assets/stylesheets/main.6543a935.min.css.map diff --git a/site/assets/stylesheets/palette.06af60db.min.css b/assets/stylesheets/palette.06af60db.min.css similarity index 100% rename from site/assets/stylesheets/palette.06af60db.min.css rename to assets/stylesheets/palette.06af60db.min.css diff --git a/site/assets/stylesheets/palette.06af60db.min.css.map b/assets/stylesheets/palette.06af60db.min.css.map similarity index 100% rename from site/assets/stylesheets/palette.06af60db.min.css.map rename to assets/stylesheets/palette.06af60db.min.css.map diff --git a/site/configuration/index.html b/configuration/index.html similarity index 56% rename from site/configuration/index.html rename to configuration/index.html index ddf84c16..8468a7b6 100644 --- a/site/configuration/index.html +++ b/configuration/index.html @@ -69,6 +69,11 @@
+ + + Skip to content + +
@@ -407,6 +412,19 @@ + + + + @@ -418,6 +436,82 @@ + + + + @@ -519,6 +613,73 @@ + + + + +
@@ -533,9 +694,88 @@ -

Configuration

- - +

Configuration

+

Account Section

+

Configure your account settings in the config.json file under the account section. This includes API keys, account names, and other related settings.

+

Parameters:

+ +

Bot Section

+

Configure your bot settings in the config.json file under the bot section. This includes strategy parameters, risk management settings, and other related settings.

+

Linear Grid Strategy Parameters

+

Here are the parameters for the linear_grid strategy in your config.json file:

+ +

Example Configuration Snippet

+
{
+  "account": {
+    "api_key": "your_api_key",
+    "api_secret": "your_api_secret",
+    "account_name": "account_1"
+  },
+  "bot": {
+    "linear_grid": {
+      "max_qty_percent_long": 50,
+      "max_qty_percent_short": 50,
+      "auto_reduce_cooldown_enabled": true,
+      "auto_reduce_cooldown_start_pct": 10,
+      "wallet_exposure_limit_long": 30,
+      "wallet_exposure_limit_short": 30,
+      "levels": 10,
+      "strength": 2,
+      "outer_price_distance": 5,
+      "min_outer_price_distance": 2,
+      "max_outer_price_distance": 10,
+      "long_mode": true,
+      "short_mode": true,
+      "reissue_threshold": 5,
+      "buffer_percentage": 1,
+      "initial_entry_buffer_pct": 0.5,
+      "min_buffer_percentage": 0.2,
+      "max_buffer_percentage": 2,
+      "enforce_full_grid": true,
+      "min_buffer_percentage_ar": 0.2,
+      "max_buffer_percentage_ar": 2,
+      "upnl_auto_reduce_threshold_long": 10,
+      "upnl_auto_reduce_threshold_short": 10,
+      "failsafe_enabled": true,
+      "failsafe_start_pct": 50,
+      "long_failsafe_upnl_pct": -20,
+      "short_failsafe_upnl_pct": -20
+    }
+  }
+}
+
diff --git a/site/docker/index.html b/docker/index.html similarity index 100% rename from site/docker/index.html rename to docker/index.html diff --git a/docs/configuration.md b/docs/configuration.md deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/docker.md b/docs/docker.md deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index ddd5ed35..00000000 --- a/docs/index.md +++ /dev/null @@ -1,3 +0,0 @@ -# Directional Scalper - -Welcome to the documentation for Directional Scalper. diff --git a/docs/installation.md b/docs/installation.md deleted file mode 100644 index 766d9dbe..00000000 --- a/docs/installation.md +++ /dev/null @@ -1,95 +0,0 @@ -# Installation - -## Prerequisites - -Before you begin, ensure you have the following prerequisites: - -- Python 3.11+ -- pip - -## Quickstart - -1. Clone the repository: - ``git clone https://github.com/donewiththedollar/directionalscalper.git`` - - Change current working directory to the project directory: - ``cd directionalscalper`` - -2. Install the required dependencies: - ``` - pip3.11 install -r requirements.txt - ``` - -3. Add your API key(s) to the `config.json` file located in the `/configs` folder. - -4. Run the bot: - - To display the menu and select a strategy, use the following command: - ``` - python3.11 multi_bot_signalscreener.py --config config.json - ``` - or - ``` - python3.11 multi_bot.py --config config.json - ``` - - Alternatively, you can run the bot with command line parameters: - - For the multi-bot auto symbol rotator strategy: - ``` - python3.11 multi_bot_signalscreener_multicore.py --exchange bybit --account_name account_1 --strategy qsgridob --config config.json - ``` - - For the old single coin strategy: - ``` - python3.11 bot.py --exchange bybit --symbol DOGEUSDT --strategy qstrendob --config config.json - ``` - -## Installing Python 3.11 - -To install Python 3.11 on your system, follow these steps: - -1. Update the package list and install the necessary dependencies: - ``` - sudo apt update - sudo apt install -y build-essential gdb lcov pkg-config \ - libbz2-dev libffi-dev libgdbm-dev libgdbm-compat-dev liblzma-dev \ - libncurses5-dev libreadline-dev libsqlite3-dev libssl-dev \ - lzma lzma-dev tk-dev uuid-dev zlib1g-dev - ``` - -2. Download the Python 3.11.0 source code: - ``` - cd /opt - wget https://www.python.org/ftp/python/3.11.0/Python-3.11.0.tgz - ``` - -3. Extract the downloaded archive: - ``` - sudo tar -xzf Python-3.11.0.tgz - ``` - -4. Change to the extracted directory: - ``` - cd Python-3.11.0 - ``` - -5. Configure the build with optimizations: - ``` - sudo ./configure --enable-optimizations --prefix=/usr/local - ``` - -6. Compile Python: - ``` - sudo make -j 8 - ``` - -7. Install Python 3.11: - ``` - sudo make altinstall - ``` - -8. Verify the installation: - ``` - python3.11 --version - ``` - -You should see the installed Python version displayed. - -That's it! You have now installed Python 3.11 on your system. diff --git a/docs/strategies.md b/docs/strategies.md deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/telegram_alerts.md b/docs/telegram_alerts.md deleted file mode 100644 index e69de29b..00000000 diff --git a/docs/usage.md b/docs/usage.md deleted file mode 100644 index e69de29b..00000000 diff --git a/site/index.html b/index.html similarity index 100% rename from site/index.html rename to index.html diff --git a/site/installation/index.html b/installation/index.html similarity index 100% rename from site/installation/index.html rename to installation/index.html diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index e75ffeb6..00000000 --- a/mkdocs.yml +++ /dev/null @@ -1,21 +0,0 @@ -site_name: Directional Scalper Documentation -theme: - name: material - features: - - navigation.tabs - - navigation.sections - palette: - primary: 'indigo' - accent: 'indigo' - font: - text: 'Roboto' - code: 'Roboto Mono' -nav: - - Home: index.md - - Installation: installation.md - - Usage: usage.md - - Configuration: configuration.md - - Strategies: strategies.md - - API Reference: api_reference.md - - Docker: docker.md - - Telegram Alerts: telegram_alerts.md diff --git a/search/search_index.json b/search/search_index.json new file mode 100644 index 00000000..eea8773a --- /dev/null +++ b/search/search_index.json @@ -0,0 +1 @@ +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Directional Scalper","text":"

Welcome to the documentation for Directional Scalper.

"},{"location":"configuration/","title":"Configuration","text":""},{"location":"configuration/#account-section","title":"Account Section","text":"

Configure your account settings in the config.json file under the account section. This includes API keys, account names, and other related settings.

"},{"location":"configuration/#parameters","title":"Parameters:","text":""},{"location":"configuration/#bot-section","title":"Bot Section","text":"

Configure your bot settings in the config.json file under the bot section. This includes strategy parameters, risk management settings, and other related settings.

"},{"location":"configuration/#linear-grid-strategy-parameters","title":"Linear Grid Strategy Parameters","text":"

Here are the parameters for the linear_grid strategy in your config.json file:

"},{"location":"configuration/#example-configuration-snippet","title":"Example Configuration Snippet","text":"
{\n  \"account\": {\n    \"api_key\": \"your_api_key\",\n    \"api_secret\": \"your_api_secret\",\n    \"account_name\": \"account_1\"\n  },\n  \"bot\": {\n    \"linear_grid\": {\n      \"max_qty_percent_long\": 50,\n      \"max_qty_percent_short\": 50,\n      \"auto_reduce_cooldown_enabled\": true,\n      \"auto_reduce_cooldown_start_pct\": 10,\n      \"wallet_exposure_limit_long\": 30,\n      \"wallet_exposure_limit_short\": 30,\n      \"levels\": 10,\n      \"strength\": 2,\n      \"outer_price_distance\": 5,\n      \"min_outer_price_distance\": 2,\n      \"max_outer_price_distance\": 10,\n      \"long_mode\": true,\n      \"short_mode\": true,\n      \"reissue_threshold\": 5,\n      \"buffer_percentage\": 1,\n      \"initial_entry_buffer_pct\": 0.5,\n      \"min_buffer_percentage\": 0.2,\n      \"max_buffer_percentage\": 2,\n      \"enforce_full_grid\": true,\n      \"min_buffer_percentage_ar\": 0.2,\n      \"max_buffer_percentage_ar\": 2,\n      \"upnl_auto_reduce_threshold_long\": 10,\n      \"upnl_auto_reduce_threshold_short\": 10,\n      \"failsafe_enabled\": true,\n      \"failsafe_start_pct\": 50,\n      \"long_failsafe_upnl_pct\": -20,\n      \"short_failsafe_upnl_pct\": -20\n    }\n  }\n}\n
"},{"location":"installation/","title":"Installation","text":""},{"location":"installation/#prerequisites","title":"Prerequisites","text":"

Before you begin, ensure you have the following prerequisites:

"},{"location":"installation/#quickstart","title":"Quickstart","text":"

  1. Clone the repository: git clone https://github.com/donewiththedollar/directionalscalper.git

    Change current working directory to the project directory: cd directionalscalper

  2. Install the required dependencies: pip3.11 install -r requirements.txt

  3. Add your API key(s) to the config.json file located in the /configs folder.

  4. Run the bot:

  5. To display the menu and select a strategy, use the following command: python3.11 multi_bot_signalscreener.py --config config.json or python3.11 multi_bot.py --config config.json
  6. Alternatively, you can run the bot with command line parameters:
    • For the multi-bot auto symbol rotator strategy: python3.11 multi_bot_signalscreener_multicore.py --exchange bybit --account_name account_1 --strategy qsgridob --config config.json
    • For the old single coin strategy: python3.11 bot.py --exchange bybit --symbol DOGEUSDT --strategy qstrendob --config config.json
"},{"location":"installation/#installing-python-311","title":"Installing Python 3.11","text":"

To install Python 3.11 on your system, follow these steps:

  1. Update the package list and install the necessary dependencies: sudo apt update sudo apt install -y build-essential gdb lcov pkg-config \\ libbz2-dev libffi-dev libgdbm-dev libgdbm-compat-dev liblzma-dev \\ libncurses5-dev libreadline-dev libsqlite3-dev libssl-dev \\ lzma lzma-dev tk-dev uuid-dev zlib1g-dev

  2. Download the Python 3.11.0 source code: cd /opt wget https://www.python.org/ftp/python/3.11.0/Python-3.11.0.tgz

  3. Extract the downloaded archive: sudo tar -xzf Python-3.11.0.tgz

  4. Change to the extracted directory: cd Python-3.11.0

  5. Configure the build with optimizations: sudo ./configure --enable-optimizations --prefix=/usr/local

  6. Compile Python: sudo make -j 8

  7. Install Python 3.11: sudo make altinstall

  8. Verify the installation: python3.11 --version

You should see the installed Python version displayed.

That's it! You have now installed Python 3.11 on your system.

"}]} \ No newline at end of file diff --git a/site/search/search_index.json b/site/search/search_index.json deleted file mode 100644 index 3be58645..00000000 --- a/site/search/search_index.json +++ /dev/null @@ -1 +0,0 @@ -{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Directional Scalper","text":"

Welcome to the documentation for Directional Scalper.

"},{"location":"installation/","title":"Installation","text":""},{"location":"installation/#prerequisites","title":"Prerequisites","text":"

Before you begin, ensure you have the following prerequisites:

"},{"location":"installation/#quickstart","title":"Quickstart","text":"

  1. Clone the repository: git clone https://github.com/donewiththedollar/directionalscalper.git

    Change current working directory to the project directory: cd directionalscalper

  2. Install the required dependencies: pip3.11 install -r requirements.txt

  3. Add your API key(s) to the config.json file located in the /configs folder.

  4. Run the bot:

  5. To display the menu and select a strategy, use the following command: python3.11 multi_bot_signalscreener.py --config config.json or python3.11 multi_bot.py --config config.json
  6. Alternatively, you can run the bot with command line parameters:
    • For the multi-bot auto symbol rotator strategy: python3.11 multi_bot_signalscreener_multicore.py --exchange bybit --account_name account_1 --strategy qsgridob --config config.json
    • For the old single coin strategy: python3.11 bot.py --exchange bybit --symbol DOGEUSDT --strategy qstrendob --config config.json
"},{"location":"installation/#installing-python-311","title":"Installing Python 3.11","text":"

To install Python 3.11 on your system, follow these steps:

  1. Update the package list and install the necessary dependencies: sudo apt update sudo apt install -y build-essential gdb lcov pkg-config \\ libbz2-dev libffi-dev libgdbm-dev libgdbm-compat-dev liblzma-dev \\ libncurses5-dev libreadline-dev libsqlite3-dev libssl-dev \\ lzma lzma-dev tk-dev uuid-dev zlib1g-dev

  2. Download the Python 3.11.0 source code: cd /opt wget https://www.python.org/ftp/python/3.11.0/Python-3.11.0.tgz

  3. Extract the downloaded archive: sudo tar -xzf Python-3.11.0.tgz

  4. Change to the extracted directory: cd Python-3.11.0

  5. Configure the build with optimizations: sudo ./configure --enable-optimizations --prefix=/usr/local

  6. Compile Python: sudo make -j 8

  7. Install Python 3.11: sudo make altinstall

  8. Verify the installation: python3.11 --version

You should see the installed Python version displayed.

That's it! You have now installed Python 3.11 on your system.

"}]} \ No newline at end of file diff --git a/site/sitemap.xml b/sitemap.xml similarity index 100% rename from site/sitemap.xml rename to sitemap.xml diff --git a/site/sitemap.xml.gz b/sitemap.xml.gz similarity index 100% rename from site/sitemap.xml.gz rename to sitemap.xml.gz diff --git a/site/strategies/index.html b/strategies/index.html similarity index 100% rename from site/strategies/index.html rename to strategies/index.html diff --git a/site/telegram_alerts/index.html b/telegram_alerts/index.html similarity index 100% rename from site/telegram_alerts/index.html rename to telegram_alerts/index.html diff --git a/site/usage/index.html b/usage/index.html similarity index 100% rename from site/usage/index.html rename to usage/index.html