Merge pull request #636 from mraniki/dev

📝 update
mraniki · Aug 7, 2023 · 89c2164 · 89c2164
2 parents 4d7839f + eb0066f
commit 89c2164
Show file tree

Hide file tree

Showing 11 changed files with 60 additions and 110 deletions.
diff --git a/.requirements/requirements.txt b/.requirements/requirements.txt
@@ -16,7 +16,7 @@ beautifulsoup4==4.12.2 ; python_version >= "3.10" and python_version < "4.0"
 bitarray==2.8.1 ; python_version >= "3.10" and python_version < "4"
 blurhash==1.1.4 ; python_version >= "3.10" and python_version < "4.0"
 browser-cookie3==0.19.1 ; python_version >= "3.10" and python_version < "4.0"
-ccxt==4.0.50 ; python_version >= "3.10" and python_version < "4.0"
+ccxt==4.0.52 ; python_version >= "3.10" and python_version < "4.0"
 certifi==2023.7.22 ; python_version >= "3.10" and python_version < "4.0"
 cffi==1.15.1 ; python_version >= "3.10" and python_version < "4.0"
 charset-normalizer==3.2.0 ; python_version >= "3.10" and python_version < "4.0"
@@ -60,7 +60,7 @@ iamlistening==3.1.4 ; python_version >= "3.10" and python_version < "4.0"
 idna==3.4 ; python_version >= "3.10" and python_version < "4.0"
 jeepney==0.8.0 ; python_version >= "3.10" and (sys_platform == "bsd" or sys_platform == "linux") and python_version < "4.0"
 jsonschema-specifications==2023.7.1 ; python_version >= "3.10" and python_version < "4.0"
-jsonschema==4.18.6 ; python_version >= "3.10" and python_version < "4.0"
+jsonschema==4.19.0 ; python_version >= "3.10" and python_version < "4.0"
 logbook==1.6.0 ; python_version >= "3.10" and python_version < "4.0"
 loguru==0.7.0 ; python_version >= "3.10" and python_version < "4.0"
 lru-dict==1.2.0 ; python_version >= "3.10" and python_version < "4.0"

diff --git a/README.md b/README.md
@@ -10,12 +10,11 @@ Easily deploy via Docker on self-hosted platform or Paas.<br>
 <br>
 <p align="left">
 <a href="https://talkytrader.github.io/wiki/"><img src="https://img.shields.io/badge/Wiki-%23000000.svg?style=for-the-badge&logo=wikipedia&logoColor=white"></a>
-<a href="https://github.com/mraniki/tt/"><img src="https://img.shields.io/badge/github-%23000000.svg?style=for-the-badge&logo=github&logoColor=white"></a>
-<a href="https://coindrop.to/mraniki"><img src="https://img.shields.io/badge/tips-000000?style=for-the-badge&logo=buymeacoffee&logoColor=white"></a><br>
+<a href="https://github.com/mraniki/tt/"><img src="https://img.shields.io/badge/github-%23000000.svg?style=for-the-badge&logo=github&logoColor=white"></a><br>
 <a href="https://hub.docker.com/r/mraniki/tt"><img src="https://img.shields.io/docker/pulls/mraniki/tt?style=for-the-badge"></a>
-<a href="https://t.me/TTTalkyTraderChat/1"><img src="https://img.shields.io/badge/talky-blue?style=for-the-badge&logo=telegram&logoColor=white"></a><br>
-<br>
-
+<br><br>
+   <img align="right" width="194" alt="screenshot" src="https://github.com/mraniki/tt/assets/8766259/14cb1653-f6b4-44e7-b07c-d930060c7363">
+   <br>
    <img src="https://img.shields.io/github/v/release/mraniki/tt?style=for-the-badge"><br>
    <a href="https://talkytrader.github.io/wiki/"><img src="https://img.shields.io/github/actions/workflow/status/mraniki/tt/%F0%9F%91%B7Flow.yml?style=for-the-badge&logo=GitHub&logoColor=white"></a><br>
 <a href="https://talky.readthedocs.io"><img src="https://readthedocs.org/projects/talky/badge/?version=latest&style=for-the-badge"></a><br>
@@ -25,49 +24,10 @@ Easily deploy via Docker on self-hosted platform or Paas.<br>
 <br><br>
 </p>
 
-<img align="right" width="194" alt="screenshot" src="https://github.com/mraniki/tt/assets/8766259/14cb1653-f6b4-44e7-b07c-d930060c7363">
-
-<details close>
-<summary>Get started</summary>
-
-<ol>
-<li>Create your channel/room and your platform bot
-<ul>
-<li>Telegram via <a href="https://core.telegram.org/bots/tutorial">Telegram @BotFather</a> and <a href="https://docs.telethon.dev/en/stable/basic/signing-in.html">create an API key</a> </li>
-<li>Discord via <a href="https://discord.com/developers/docs/intro">Discord Dev portal</a></li>
-<li>Matrix via <a href="https://turt2live.github.io/matrix-bot-sdk/index.html">Matrix.org</a></li>
-</ul></li>
-<li>Get your
-<ul>
-<li><a href="https://support.metamask.io/hc/en-us/articles/360015289632-How-to-export-an-account-s-private-key">DEX wallet address and private key</a></li>
-<li><a href="https://github.com/ccxt/ccxt">CEX API Keys</a></li>
-</ul></li>
-<li>Create <a href="https://talky.readthedocs.io/en/latest/01_start.html#create-your-config-file-settings-toml-or-use-env-variables">your config file settings.toml or use env variables</a></li>
-
-<li>Deploy via:
-   <ul> 
-<li>docker 
-          <code>docker pull mraniki/tt:latest</code> or <code>docker pull ghcr.io/mraniki/tt:latest</code></li>
-<li>locally 
-          <code>git clone https://github.com/mraniki/tt:main</code> && <code>pip install -r requirements.txt</code> </li>
-</ul></li>
-<li>Start your container or if deployed locally use <code>python3 bot.py</code> to start </li>
-<li>Try it now</li>
-<a href="https://app.koyeb.com/deploy?type=docker&image=docker.io/mraniki/tt&name=tt-demo"><img src="https://img.shields.io/badge/Deploy%20on%20Koyeb-blue?style=for-the-badge&logo=koyeb"></a>
-</ol>
-
-</details>
-
-<br>
-
 <h5>Documentation</h5>
 <a href="https://talky.readthedocs.io/"><img src="https://img.shields.io/badge/Documentation-000000?style=for-the-badge&logo=readthedocs&logoColor=white"></a><br>
 
-
 <br>
 <HR>
-</div>
-
-
-<div style="text-align: left; font-size: x-small; font-style:italic;">
-⚠️ <p > This is an education tool and should not be considered professional financial investment system nor financial advice.<br>Use a testnet account or USE AT YOUR OWN RISK. Never share your private keys or API secrets.<br>Never use your main account for automatic trade.<br>DYOR.</p></div>
+<br>
+</div>
diff --git a/docs/01_start.rst b/docs/01_start.rst
@@ -8,9 +8,8 @@ Chat Platform Credentials
 
 Create your channel/room and your platform bot:
 
-   :doc:`talky:04_iamlistening`
+:doc:`iamlistening:index`
 
-   :doc:`iamlistening:index`
 
 Exchange Credentials
 ====================

diff --git a/docs/02_config.rst b/docs/02_config.rst
@@ -3,31 +3,37 @@
 Config
 ======
 
+.. toctree::
+   :maxdepth: 3
+
+   02_config
+
+
 Dynaconf
 ========
 
 Dynaconf https://www.dynaconf.com/ is a powerful and easy-to-use configuration management library for Python.
-Talky settings are based on Dynaconf.
-
+Talky settings are based on Dynaconf. it support toml settings file, .env file or environment variable 
+Refer to Dynaconf for more information.
 
-Settings  Structure
-===================
+Settings Structure
+==================
 
 Config will load:
-    - load talky default: talky_settings.toml
-    - load default from library: default_settings.toml
-    - load user settings: settings.toml
-    - load user secrets: .secrets.toml
+    - talky default: talky_settings.toml
+    - default from library if the library support it: default_settings.toml
+    - user settings: settings.toml
+    - user secrets: .secrets.toml
 
-Your settings should be setup in settings.toml or .secrets.toml
-Settings.toml or .env can be located in /app/settings.toml or /app/.env for docker.
-If deployed locally, place your settings.toml or .env in /tt.
+Your settings should be setup in settings.toml, .secrets.toml, .env or environment variable.
+Settings.toml or .env can be located in :file:`/app/settings.toml` or :file:`/app/.env` for docker.
+If deployed locally, place your file in :file:`/tt/` folder.
 
 
 Talky Settings
 ==============
 
- More than 100 settings customizable via settings.toml or .env
+More than 100 settings customizable via settings.toml or .env
 
 
 .. literalinclude:: ../tt/talky_settings.toml
@@ -42,10 +48,14 @@ Settings.toml
 example:
 
 .. literalinclude:: ../examples/example_settings.toml
+   :linenos:
+
 
 .env or ENV VARS
 ------------------
 
 place the .env at
 
 .. literalinclude:: ../examples/example.env
+   :linenos:
+
diff --git a/docs/03_module.rst b/docs/03_module.rst
@@ -1,6 +1,6 @@
-======
-Module
-======
+==================
+TalkyTrader Module
+==================
 
 .. autosummary::
    :toctree: _autosummary

diff --git a/docs/04_iamlistening.rst b/docs/04_iamlistening.rst
@@ -2,36 +2,6 @@
 iamlistening
 ===========
 
-
-Chat Platform Credentials
-=========================
-
-
-
-Telegram
---------
-
-- Create your bot token via Telegram @BotFather 
-- Telegram portal to create an API key
-
-
-Discord
--------
-
-
-Matrix
-------
-
-
-Guilded
--------
-
-
-Mastodon
---------
-
-
-
 Module Reference
 ================
 

diff --git a/docs/05_findmyorder.rst b/docs/05_findmyorder.rst
@@ -2,15 +2,7 @@
 findmyorder
 ===========
 
-
-Order Example
-=============
-
-
-
-
 Module Reference
 ================
 
-
-:doc:`findmyorder:index`
+:doc:`findmyorder:index`
diff --git a/docs/_static/screenshot.png b/docs/_static/screenshot.png
diff --git a/docs/development/index.rst b/docs/development/index.rst
@@ -1,15 +1,30 @@
 ====================
 Build your own Plugin
 =====================
+
+
 You can fork this repo or you can use the current repo and add your own plugins
 
+
+=================
+Community Plugins
+=================
+
+
+:doc:`community:index`
+
+
 Build Plugin
 ============
 
+
 .. literalinclude:: ../tt/plugins/default_plugins/example_plugin.py
 
 
+
 Use your Plugin
 ===============
 
-:doc:`community:index`
+
+:doc:`community:index`
+
diff --git a/docs/index.rst b/docs/index.rst
@@ -23,6 +23,15 @@ TalkyTrader
    </p>
 
 
+
+|  
+
+.. image:: ../docs/_static/screenshot.png
+  :width: 200
+  :alt: logo
+  :align: right
+
+
 User Guide
 ==========
 

diff --git a/docs/plugins/user_defined.rst b/docs/plugins/user_defined.rst