Update command name and documentation
This commit is contained in:
+7
-5
@@ -95,11 +95,13 @@ Make sure that the following 2 lines are available in your docker-compose file:
|
|||||||
|
|
||||||
### Consuming the API
|
### Consuming the API
|
||||||
|
|
||||||
You can consume the API by using the script `scripts/rest_client.py`.
|
You can consume the API by using `freqtrade-client` (also available as `scripts/rest_client.py`).
|
||||||
The client script only requires the `requests` module, so Freqtrade does not need to be installed on the system.
|
This command can be installed independent of the bot by using `pip install freqtrade-client`.
|
||||||
|
|
||||||
|
This module is designed to be lightweight, and only depends on the `requests` and `python-rapidjson` modules, skipping all heavy dependencies freqtrade otherwise needs.
|
||||||
|
|
||||||
``` bash
|
``` bash
|
||||||
python3 scripts/rest_client.py <command> [optional parameters]
|
freqtrade-client <command> [optional parameters]
|
||||||
```
|
```
|
||||||
|
|
||||||
By default, the script assumes `127.0.0.1` (localhost) and port `8080` to be used, however you can specify a configuration file to override this behaviour.
|
By default, the script assumes `127.0.0.1` (localhost) and port `8080` to be used, however you can specify a configuration file to override this behaviour.
|
||||||
@@ -120,7 +122,7 @@ By default, the script assumes `127.0.0.1` (localhost) and port `8080` to be use
|
|||||||
```
|
```
|
||||||
|
|
||||||
``` bash
|
``` bash
|
||||||
python3 scripts/rest_client.py --config rest_config.json <command> [optional parameters]
|
freqtrade-client --config rest_config.json <command> [optional parameters]
|
||||||
```
|
```
|
||||||
|
|
||||||
### Available endpoints
|
### Available endpoints
|
||||||
@@ -176,7 +178,7 @@ python3 scripts/rest_client.py --config rest_config.json <command> [optional par
|
|||||||
Possible commands can be listed from the rest-client script using the `help` command.
|
Possible commands can be listed from the rest-client script using the `help` command.
|
||||||
|
|
||||||
``` bash
|
``` bash
|
||||||
python3 scripts/rest_client.py help
|
freqtrade-client help
|
||||||
```
|
```
|
||||||
|
|
||||||
``` output
|
``` output
|
||||||
|
|||||||
@@ -42,7 +42,7 @@ Documentation = "https://freqtrade.io"
|
|||||||
|
|
||||||
|
|
||||||
[project.scripts]
|
[project.scripts]
|
||||||
ft_rest = "freqtrade_client.ft_client:main"
|
freqtrade-client = "freqtrade_client.ft_client:main"
|
||||||
|
|
||||||
[tool.setuptools.packages.find]
|
[tool.setuptools.packages.find]
|
||||||
where = ["."]
|
where = ["."]
|
||||||
|
|||||||
Reference in New Issue
Block a user