Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📝 🔧 settings documentation #267

Merged
merged 6 commits into from
Aug 8, 2023
Merged

📝 🔧 settings documentation #267

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ed34ad7
:memo:
mraniki Aug 7, 2023
5c114a6
📝 conf update for intersphinx
mraniki Aug 7, 2023
7628393
📝 adding pyscript
mraniki Aug 8, 2023
66e7dca
📝
mraniki Aug 8, 2023
8c9c490
⚗️ pyscript
mraniki Aug 8, 2023
b80cd67
📝 🔧 settings documentation
mraniki Aug 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 27 additions & 1 deletion docs/01_start.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,30 @@ The following example illustrate how to use the module

.. literalinclude:: ../examples/example.py



PyScript
========

.. raw:: html

<br>

<html>
<head>
<link rel="stylesheet" href="https://pyscript.net/latest/pyscript.css" />
<script defer src="https://pyscript.net/latest/pyscript.js"></script>
</head>
<body>
<py-config>
packages = ["findmyorder"]
</py-config>
<py-script>
from findmyorder import FindMyOrder

fmo = FindMyOrder()
print(fmo)


</py-script>
</body>
</html>
9 changes: 5 additions & 4 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,13 @@
"talky": ("https://talky.readthedocs.io/en/latest", None),
"talky-dev": ("https://talky.readthedocs.io/en/dev/", None),
"findmyorder": (
"https://talky.readthedocs.io/projects/findmyorder/en/latest", None),
"dxsp": ("https://talky.readthedocs.io/projects/dxsp/en/latest", None),
"https://findmyorder.readthedocs.io/en/latest", None),
"dxsp": ("https://dxsp.readthedocs.io/en/latest", None),
"iamlistening": (
"https://iamlistening.readthedocs.io/en/latest", None),
"talkytrend": ("https://talky.readthedocs.io/projects/talkytrend/en/latest", None),
"myllm": ("https://talky.readthedocs.io/projects/myllm/en/latest", None),
"talkytrend": ("https://talkytrend.readthedocs.io/en/latest", None),
"myllm": ("https://myllm.readthedocs.io/en/latest", None),
"community": ("https://tt-plugins.readthedocs.io/en/latest", None),
}

intersphinx_disabled_reftypes = ["*"]
Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
FindMyOrder
===========


.. image:: ../docs/_static/logo-full.png
:width: 200
:alt: logo
Expand Down
95 changes: 24 additions & 71 deletions findmyorder/default_settings.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,99 +11,52 @@
# port = 8081
# or via ENVVARS
# export TT_PORT=8081


[default]
# Dynaconf settings verification
VALUE = "Production - Default"

# Module Enable/Disable
findmyorder_enabled = true

# Keyword to be use to identify an order
action_identifier = "BUY SELL LONG SHORT"
# Keyword identifier for stoploss
stop_loss_identifier = "sl="
# Keyword identifier for take-profit
take_profit_identifier = 'tp='
# Keyword identifier for quantity
quantity_identifier = 'q='
# Keyword identifier for order type
order_type_identifier = "spot future margin"
# Keyword identifier for leverage
leverage_type_identifier = "cross isolated"
# Keyword identifier for comments
comment_identifier = "comment="

# Stoploss default value is none is provided
stop_loss = 1000
# Take-Profit default value is none is provided
take_profit = 1000
# Quantity default value is none is provided
quantity = 1

# Settings to enable or disable
# instrument mapping
instrument_mapping = true
# instrument mapping to use and alternative
# symbol when generating the order
mapping = [
{ id = "GOLD", alt = "XAUUSD" },
{ id = "SILVER", alt = "XAGUSD" },
{ id = "BTC", alt = "WBTC" },
{ id = "ETH", alt = "WETH" },
]

# Instrument to be ignored
# when generating an order
ignore_instrument = "US500 USTEC DOGE"

########################################
### END OF DEFAULT SETTINGS ###
########################################





# _ _ _ ___
#| | | | | | |__ \
#| |_| |__ ___ ___ _ __ __| | )|
#| __| '_ \ / _ \ / _ \ '_ \ / _` | / /
#| |_| | | | __/ | __/ | | | (_| | |_|
# \__|_| |_|\___| \___|_| |_|\__,_| (_)
########################################






########################################
### TESTING SETTINGS ###
########################################

[testing]
VALUE = "On Testing"
findmyorder_enabled = true
action_identifier = "BUY SELL LONG SHORT"
actions = [
{ identifier = "BUY", type = "BUY" },
{ identifier = "SELL", type = "SELL" },
{ identifier = "LONG", type = "BUY" },
{ identifier = "SHORT", type = "SELL" }
]
stop_loss_identifier = "sl="
take_profit_identifier = 'tp='
quantity_identifier = 'q='
order_type_identifier = "spot future margin"
leverage_type_identifier = "cross isolated"
comment_identifier = "comment="
stop_loss = 1000
take_profit = 1000
quantity = 1
instrument_mapping = true
mapping = [
{ id = "GOLD", alt = "XAUUSD" },
{ id = "SILVER", alt = "XAGUSD" },
{ id = "BRENTOIL", alt = "UKOil" },
{ id = "CRUDEOIL", alt = "USOil" },
{ id = "NATURALGAS", alt = "NGAS" },
{ id = "GERMANY40", alt = "DE30" },
{ id = "US500", alt = "US500" },
{ id = "US2000", alt = "US2000" },
{ id = "DOLLARINDEX", alt = "DXY" },
{ id = "VIX", alt = "VIX" },
{ id = "US30", alt = "DJ30" },
{ id = "US100", alt = "USTEC" },
{ id = "EU50", alt = "STOXX50" },
{ id = "UK100", alt = "UK100" },
{ id = "HK50", alt = "HK50" },
{ id = "AU200", alt = "AUS200" },
{ id = "NIKKEI225", alt = "JPN225" },
{ id = "NIFTY50", alt = "IND50" },
{ id = "CAC40", alt = "F40" },
{ id = "AAPL", alt = "AAPL" },
{ id = "TSLA", alt = "TSLA" },
{ id = "BTC", alt = "WBTC" },
{ id = "ETH", alt = "WETH" },
{ id = "BNB", alt = "BNB/USDT" },
{ id = "MATIC", alt = "MATIC-PERP" }
]
########################################