Giter VIP home page Giter VIP logo

cbbi's Introduction

ColinTalksCrypto Bitcoin Bull Run Index (CBBI)

GitHub Pipenv locked Python version GitHub GitHub Repo stars

The official Python implementation of the ColinTalksCrypto Bitcoin Bull Run Index (CBBI).

The CBBI is a Bitcoin index that utilizes advanced, real-time analysis of 10 metrics to help us understand what stage of the Bitcoin bull run and bear market cycles we are in. The CBBI is time-independent and price-independent. It simply indicates whether it believes we are approaching the top/bottom of a Bitcoin cycle.

If you want to learn more, check out this video.

Visit our website

Bookmark it to receive latest CBBI updates.

Script demo

asciicast

Docker usage

Execute the script

$ docker run --rm --pull=always zaczero/cbbi --help

$ docker run --rm --pull=always zaczero/cbbi

Manual usage

Recommended Python version: 3.10

Install pipenv

Pipenv: Python Dev Workflow for Humans

Install required packages

NOTE: The pipenv commands shall be executed within the project directory.

$ pipenv install

Execute the script

$ pipenv run python main.py --help

$ pipenv run python main.py

or

$ pipenv shell

$> python main.py --help

$> python main.py

Metrics table

The current CBBI version (March 2022) includes the following metrics:

Name Link
Pi Cycle Top Indicator Visit page
RUPL/NUPL Chart Visit page
RHODL Ratio Visit page
Puell Multiple Visit page
2 Year Moving Average Visit page
Bitcoin Trolololo Trend Line Visit page
MVRV Z-Score Visit page
Reserve Risk Visit page
Woobull Top Cap vs CVDD Visit page
Google Trends for "Bitcoin" Visit page

Environment variables

This project supports .env files which provide a convenient way of setting environment variables.

GOOGLE_PROXY

Defines a requests-supported proxy string used during Google Trends metric calculation. If unset or empty, a direct connection will be made. It can be used to resolve the Google returned a response with code 429 issue.

Example usage

GLASSNODE_API_KEY

Defines an API key to be used during GlassNode fallback requests. If unset or empty, a cache fallback will be used instead (via CBBI.info).

Example usage

  • GLASSNODE_API_KEY=REPLACE_ME

TELEGRAM_TOKEN, TELEGRAM_CHAT_ID

Define both variables to receive Telegram notifications about metric errors that occur during the execution.

Example usage

  • TELEGRAM_TOKEN=REPLACE_ME
  • TELEGRAM_CHAT_ID=123456

Footer

Contact

cbbi's People

Contributors

zaczero avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.