Setup Guide

Setup Guide

1. Install Dependencies

   • Easy mode (might clash with current depends)

     pip install -r requirements.txt

   • Prefered Method (venv)

     python3 -m venv .venv
     
     source .venv/bin/activate # linux
     .\.venv/scripts/activate # windows
     
     pip install -r requirements.txt

2. Copy creds.example.yml to creds.yml (or whatever you want.) and update the creds.

   # linux: Copy file over.
   cp creds.example.yml creds.yml
   
   # windows: either copy the file in explorer and rename to 'creds.yml' or use
   copy creds.example.yml creds.yml
   
   # powershell
   Copy-Item creds.example.yml -Destination creds.yml

3. Edit the credentials yaml file and enter your API key.

   # MAIN NET
   prod:
       access_key: replace_me
       secret_key: replace_me

4. Configure input params as in config.yml (see configuration wiki)

5. Run the script

   • Standard

     python3 Binance\ Detect\ Moonings.py

   • Background process (linux only)

     nohup python3 -u Binance\ Detect\ Moonings.py >> log.txt 2>&1 &

     The logs are stored in log.txt. To stop the process either look in your process list with ps aux | grep -i python3 and kill with kill PROCESS_ID or killall python3 when you know what you're doing.

Use the --help flag if you want to see supported arguments

optional arguments:
  -h, --help            show this help message and exit
  --debug, -d           extra logging
  --config CONFIG, -c CONFIG
                        Path to config.yml
  --creds CREDS, -u CREDS
                        Path to creds file