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.

Bookmark it and receive latest CBBI updates.

• CBBI.info

To use the CBBI script with Docker, run the following command:

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

To use the CBBI script without Docker, follow these steps:

Recommended Python version: 3.11

Pipenv: Python Dev Workflow for Humans

# TLDR;
$ pip install --user pipenv

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

$ pipenv install

$ pipenv run python main.py --help
$ pipenv run python main.py

$ pipenv shell
$> python main.py --help
$> python main.py

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

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

To use this feature, create a file called .env in the project's root directory, and add environment variables in the following format:

VARIABLE_NAME=value

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).

• GLASSNODE_API_KEY=REPLACE_ME

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

• TELEGRAM_TOKEN=REPLACE_ME
• TELEGRAM_CHAT_ID=123456

https://monicz.dev/#get-in-touch

This project is licensed under the GNU Affero General Public License v3.0.

The complete license text can be accessed in the repository at LICENSE.