https://github.com/cemkiy/escobar

Calculates the correctness of the functions you write for the crypto coin market.
https://github.com/cemkiy/escobar

bot cryptocurrency

Last synced: 3 months ago
JSON representation

Calculates the correctness of the functions you write for the crypto coin market.

• Host: GitHub
• URL: https://github.com/cemkiy/escobar
• Owner: cemkiy
• Created: 2015-10-24T07:41:44.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-04-15T08:24:45.000Z (about 7 years ago)
• Last Synced: 2025-01-23T00:22:40.658Z (4 months ago)
• Topics: bot, cryptocurrency
• Language: Python
• Homepage:
• Size: 35.2 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


![alt tag](https://d13yacurqjgara.cloudfront.net/users/322905/screenshots/2273155/pablo_v7.gif)

# Escobar

Escobar is a crypto coin statics helper. It's purpose is determine the accuracy of your functions.

  - Light Weight

  - Yo Notifications

  - No Requirements Databases

  - Uses Coin Market Cap datas

  - Escobar wise every time

  - Python 3.x

# How does it work

Escobar assigns a value to each function. The sum of these values does not exceed 100. That is, each function has a percentage of accuracy. These values are recalculated according to the results they give. And escobar is more intelligent in every work. You can examine the JSON files it creates(exp: weight_bitcoin.json).

You can run the escobar at any interval.

    python3 escobar.py

# Environment

Before install requirements.txt.

    pip3 install requirements.txt

Please set up your environment variables. Create .env file. Details: [real environment](https://github.com/cemkiy/python-shell-environment)

        coin_name=bitcoin

        currency=USD

        notify_high_yo_api_key=

        notify_constant_yo_api_key=

        notify_fall_yo_api_key=

# Write Your Own Functions

 1. Write your own function to forecast.py. The functions can only return 0,1 or -1.

 0 is will be ignored. 1 is rises and -1 is falls . Example func:

 ```python

def trend_by_weekdays(self):

        weekno = datetime.datetime.today().weekday()

        if weekno < 5:

            # weekday

            return 0

        else:

            # weekend

            return -1

```

2. Register the functions you want to run in escobar.py.

 ```python

functions_to_be_run = {

    'trend_by_perc': Forecast.trend_by_perc,

    'trend_by_weekdays': Forecast.trend_by_weekdays

}

```

Done. You can now run and view the results.

# Yo

Yo sends only yo. Escobar script is use this features for send notification about results.