[BUILD][TRANSFER][PUBLISH]

Author: github-actions

README.md

@@ -1,49 +1,15 @@
-# bingx-python
-Python SDK (sync and async) for Bingx with Rest and WS capabilities.
+# about
 
-You can check Bingx's docs here: [Docs](https://ccxt.com)
+this is internal dev repo, not meant to be used by end users.
 
+# instructions
 
-You can check the SDK docs here: [SDK](https://docs.ccxt.com/#/exchanges/bingx)
+- At first, generate `Personal Access Token` under `CCXT` org, with the access to this current repository and also to all other repositories (there are around 20 repositories named like: `github.com/ccxt/{exchange}-python`) with the scopes `actions, commit statuses, contents, workflows` and set that value for action secret with the name `API_TOKEN_FOR_CCXT_SINGLE_EXCHANGES`.
 
-*This package derives from CCXT and allows you to call pretty much every endpoint by either using the unified CCXT API or calling the endpoints directly*
+- Then inside `.github/workflows/transfer-all.yml` set the desired array of exchanges in matrix. On `push` event, if commit message contains `[TRANSFER]`, this repo files will be distributed to those dozen exchange repositories.
 
-## Installation
+- Immediately, as those repositories get `push` event (if commit message contains the phrase `[BUILD]`) the individual exchange repos start build with `.github/workflows/build-single-exchange.yml` flow, so the exchange-specific package is generated from raw skeleton repo & ccxt files. 
 
-```
-pip install bingx
-```
-
-## Usage
-
-### Async
-
-```Python
-from bingx import BingxAsync
-
-async def main():
-    instance = BingxAsync({})
-    order = await instance.create_order(__EXAMPLE_SYMBOL__, "limit", "buy", 1, 100000)
-```
-
-### Sync
-
-```Python
-from bingx import BingxSync
-
-def main():
-    instance = BingxSync({})
-    order =  instance.create_order(__EXAMPLE_SYMBOL__, "limit", "buy", 1, 100000)
-```
-
-### Websockets
-
-```Python
-from bingx import BingxWs
-
-async def main():
-    instance = BingxWs({})
-    while True:
-        orders = await instance.watch_orders(__EXAMPLE_SYMBOL__)
-```
+- If commit message also contained the phrase `[PUBLISH]` then they will push a package to pypi.org (you should set `PYPI_API_SECRET_SP` secret with pypi api key, under each repository). Versions are incremental by patch version at this moment.
 
+- All other things are WIP and can be customized.

build/build.ts

@@ -148,7 +148,7 @@ class build {
         const otherStrings = {
             '__LINK_TO_OFFICIAL_EXCHANGE_DOCS__': 'https://ccxt.com',
             '__PYTHON_PACKAGE_NAME__': undefined,
-            '__TEST_SYMBOL__': 'BTC/USDC',
+            '__EXAMPLE_SYMBOL__': 'BTC/USDC',
         };
         const exchangeConfig = this.globalConfigs['exchanges'][this.exchange];
         for (const key in otherStrings) {

build/global-configs.json

@@ -36,7 +36,7 @@
         },
         "hyperliquid": {
             "__PYTHON_PACKAGE_NAME__": "hyperliquid",
-            "__TEST_SYMBOL__": "BTC/USDC:USDC"
+            "__EXAMPLE_SYMBOL__": "BTC/USDC:USDC"
         },
         "kucoin": {
             "__PYTHON_PACKAGE_NAME__": "kucoin-api"

build/templates/examples/async.py

@@ -14,7 +14,7 @@
 async def main():
     instance = __ExchangeName__Async({})
     await instance.load_markets()
-    symbol = "__TEST_SYMBOL__"
+    symbol = "__EXAMPLE_SYMBOL__"
 
     # fetch ticker
     #

build/templates/examples/sync.py

@@ -10,7 +10,7 @@
 def main():
     instance = __ExchangeName__Sync({})
     instance.load_markets()
-    symbol = "__TEST_SYMBOL__"
+    symbol = "__EXAMPLE_SYMBOL__"
 
     # fetch ticker
     #

build/templates/examples/websockets.py

@@ -29,7 +29,7 @@ async def my_watch_orderbook(exchange, symbol):
 async def main():
     instance = __ExchangeName__Ws({})
     await instance.load_markets()
-    symbol = "__TEST_SYMBOL__"
+    symbol = "__EXAMPLE_SYMBOL__"
 
     # fetch ticker
     ticker = my_watch_ticker_my(instance, symbol)