https://github.com/retgal/mayer
https://github.com/retgal/mayer
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/retgal/mayer
- Owner: RetGal
- License: agpl-3.0
- Created: 2021-08-04T20:18:34.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-07T18:27:04.000Z (over 1 year ago)
- Last Synced: 2025-05-20T04:11:18.236Z (about 1 year ago)
- Language: Python
- Size: 48.8 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MayeR
## Voraussetzungen
*MayeR* setzt *Python* Version 3 oder grösser voraus.
Im Kern verwendet *MayeR* die [ccxt](https://github.com/ccxt/ccxt) Bibliothek. Diese gilt es mittels [pip](https://pypi.org/project/pip/) zu installieren:
`python -m pip install -r requirements.txt`
### Mayer Multiple
*mayer.py* ermittelt stündlich den BTC/USD Kurs und aktualisert damit den Tagesdurschnittskurs.
Aufgrund des Durschnittskurses der letzten 200 Tage und dem aktuellen Kurswert können *BalanceR* Instanzen sehr genaue und aktuelle Mayer Multiples berechnen.
Vor dem erstmaligen Start ist die Konfigurationsdatei *mayer.txt* mit dem Namen der gewünschten Börse zu ergänzen.
Der Name der zu verwendenden Konfigurationsdatei kann als Parameter, ohne der Dateierweiterung (*.txt*), übergeben werden:
`./mayer.py mayer`
Fehlt der Parameter, so fragt das Script bei jedem Start nach dem Namen der Konfigurationsdatei. Diesen gilt es ohne Dateierweiterung (*.txt*) einzugeben. Wird dieser Schritt übersprungen, so wird standardmässig die Konfiguration von *mayer.txt* verwendet.
## Betrieb
### Mayer Instanz
Soll die *MayeR* Instanz mit Hilfe des Watchdog-Scrpits *mayer_osiris.sh* überwacht werden, so ist die Installation von [tmux](https://github.com/tmux/tmux/wiki) notwendig.
`apt install tmux`
Im *mayer_osiris.sh* muss der Variable *workingDir* der absolute Pfad zum *mayer.py* Script angegeben werden.
Damit *mayer_osiris.sh* die *Mayer* Instanz kontinuierlich überwachen kann, muss ein entsprechender *Cronjob* eingerichtet werden:
`*/6 * * * * /home/bot/balancer/mayer_osiris.sh`
Die beiden Dateien *mayer.py* und *mayer_osiris.sh* müssen vor dem ersten Start mittels `chmod +x` ausführbar gemacht werden.
## Docker
Container builden
```bash
docker build -t retgal/mayer:latest .
```
MayeR mit der externen config mayer.txt starten
```bash
docker run -it -v /opt/data:/opt/data -e MAYER_CONFIG="/opt/data/mayer" --name mayer retgal/mayer:latest
```
Oder dasselbe ohne zu builden mit dem vorgefertigten von Dockerhub:
```bash
docker pull dockerocker/mayer
docker run -it -v /opt/data:/opt/data -e MAYER_CONFIG="/opt/data/mayer" --name mayer dockerocker/mayer:latest
```
Die optionalen Parameter in der config sollten gesetzt sein und sich innerhalb des Volume-Pfads befinden.
Also beispielsweise:
```
db_name = "/opt/data/mayer.db"
mayer_file = "/opt/data/mayer.avg"
```