Skip to content

Minor improvements to the docs #25

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.

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

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p

## 0.8.0.dev (development stage/unreleased/unstable)
### Added
- Additional infos for a better user experience
- Additional info for a better user experience

## 0.8.0
### Added
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ If you put this engine on a market, you should stop trading manually on this mar
Part of ['UNICORN Binance Suite'](https://www.lucit.tech/unicorn-binance-suite.html).

## How to start the trailing stop loss engine:
```
```python
from unicorn_binance_trailing_stop_loss.manager import BinanceTrailingStopLossManager


Expand Down Expand Up @@ -84,19 +84,19 @@ ubtsl = BinanceTrailingStopLossManager(callback_error=callback_error,
```

### Stop the engine:
```
```python
ubtsl.stop_manager()
```

### Get the right [logger](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-trailing-stop-loss/blob/master/example_logging.py):
```
```python
logging.getLogger("unicorn_binance_trailing_stop_loss")
```

[Discover more possibilities](https://unicorn-binance-trailing-stop-loss.docs.lucit.tech/unicorn_binance_trailing_stop_loss.html).

## Start the engine on the command line (Windows, Linux and Mac):
```
```sh
$ ubtsl --profile BTCUSDT_SELL --stoplosslimit 0.5%
```

Expand Down
7 changes: 3 additions & 4 deletions bot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,20 +73,19 @@ from GitHub.
8. Read the following [post installation instructions](https://www.lucit.tech/ubtsl-cli.html#installation).

### Mac
Comming soon! Receive a
Coming soon! Receive a
[notification](https://www.lucit.tech/unicorn-binance-trailing-stop-loss-bot.html#receive-notifications) on release.

## Update
### Windows
Just start `ubtsl` with the parameter `--installupdate`. Only available in the bot version!

```
```sh
$ ubtsl --installupdate
```

### Mac
Comming soon! Receive a
[notification](https://www.lucit.tech/unicorn-binance-trailing-stop-loss-bot.html#receive-notifications) on release.
Coming soon! Receive a [notification](https://www.lucit.tech/unicorn-binance-trailing-stop-loss-bot.html#receive-notifications) on release.

## Change Log
[https://unicorn-binance-trailing-stop-loss.docs.lucit.tech/CHANGELOG.html](https://unicorn-binance-trailing-stop-loss.docs.lucit.tech/CHANGELOG.html)
Expand Down
42 changes: 21 additions & 21 deletions cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,83 +85,83 @@ usability immensely.
### Create `ubtsl_config.ini`
A fresh `ubtsl_config.ini` file can be created with the following command

```
```sh
$ ubtsl --createconfigini
```

### Create `ubtsl_profiles.ini`
The same command is available for the `ubtsl_profiles.ini` file:

```
```sh
$ ubtsl --createprofilesini
```

### Open `ubtsl_config.ini`
Open the used `ubtsl_config.ini` file in a GUI editor:

```
```sh
$ ubtsl --openconfigini
```

### Open `ubtsl_profiles.ini`
The same command is available for the `ubtsl_profiles.ini` file:

```
```sh
$ ubtsl --openprofilesini
```

### Test the notification settings
If you entered valid email and/or Telegram settings you can test the notification system:

```
```sh
$ ubtsl --test notification
```

### Test connectivity to Binance API
If you entered valid API key and secret you can test the connectivity to the Binance API:

```
```sh
$ ubtsl --test binance-connectivity
```

### Test data streams
Test the data streams, this test needs a defined exchange and market parameter:

```
```sh
$ ubtsl --test streams --exchange binance.com --market BTCUSDT
```

It is possible to use `exchange` and `market` values of a profile.

```
```sh
$ ubtsl --profile "BTCUSDT_SELL" --test streams
```

## Usage

```
```sh
$ ubtsl --help
```

Alternatively, it is possible to run `ubtsl` in the Python environment as follows (not available in the bot/stand alone variant):

Linux/Mac:

```
```sh
$ python3 -m ubtsl --help
```

Windows:

```
```sh
$ py -m ubtsl --help
```

### Load a profile

If profiles are available, they can be activated with the `--profile` parameter at startup.

```
```sh
$ ubtsl --profile BTCUSDT_SELL
```

Expand All @@ -173,7 +173,7 @@ Any CLI parameters will overwrite predefined values from the profile.

All parameters that expect numbers can be configured with fixed numerical values as well as with percentage values.

```
```sh
$ ubtsl --help
usage: ubtsl [-h] [-ak APIKEY] [-as APISECRET] [-bt BORROWTHRESHOLD] [-coo] [-cci] [-cpi] [-cf CONFIGFILE] [-cu]
[-ex EXAMPLE] [-e EXCHANGE] [-n ENGINE] [-k KEEPTHRESHOLD] [-lf LOGFILE] [-ll LOGLEVEL] [-loo]
Expand Down Expand Up @@ -249,12 +249,12 @@ options:

## Example commands
### Check if a new update is available
```
```sh
$ ubtsl --checkupdate
```

### Show program version
```
```sh
$ ubtsl --version
```

Expand All @@ -263,7 +263,7 @@ Arguments defined in the CLI overrule values from the loaded profile!

Start with profile "BTCUSDT_SELL" and overwrite the stoplosslimit:

```
```sh
$ ubtsl --profile BTCUSDT_SELL --stoplosslimit 0.5%
```

Expand All @@ -276,32 +276,32 @@ of the [example_ubtsl_profiles.ini](https://github.com/LUCIT-Systems-and-Develop
By activating the `jump-in-and-trail` engine, the bot first buys the predefined asset amount and then trails them
automatically.

```
```sh
$ ubtsl --profile BTCUSDT_SMART_ENTRY
```

### List all open orders
Get a list of all open orders.

```
```sh
$ ubtsl --exchange "binance.com" --market "BTCUSDT" --listopenorders
```

It is possible to use `exchange` and `market` values of a profile.

```
```sh
$ ubtsl --profile "BTCUSDT_SELL" --listopenorders
```

### Cancel all open orders

```
```sh
$ ubtsl --exchange "binance.com" --market "BTCUSDT" --cancelopenorders
```

It's possible to use `exchange` and `market` values of a profile.

```
```sh
$ ubtsl --profile "BTCUSDT_SELL" --listopenorders
```

Expand Down
2 changes: 1 addition & 1 deletion unicorn_binance_trailing_stop_loss/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ def main(is_bot=False):

parser.add_argument('-ak', '--apikey',
type=str,
help="the API key",
help="The API key",
required=False)
parser.add_argument('-as', '--apisecret',
type=str,
Expand Down
Loading