{"id":21238630,"url":"https://github.com/zaczero/cbbi","last_synced_at":"2025-04-04T13:09:53.170Z","repository":{"id":43405543,"uuid":"353337079","full_name":"Zaczero/CBBI","owner":"Zaczero","description":"📊 The official Python implementation of the ColinTalksCrypto Bitcoin Bull Run Index (CBBI)","archived":false,"fork":false,"pushed_at":"2024-11-12T01:34:16.000Z","size":11628,"stargazers_count":169,"open_issues_count":1,"forks_count":51,"subscribers_count":10,"default_branch":"main","last_synced_at":"2025-03-28T12:06:18.013Z","etag":null,"topics":["bitcoin","confidence-score","cryptocurrency","docker","poetry","price-evaluation","python"],"latest_commit_sha":null,"homepage":"https://cbbi.info","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Zaczero.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-03-31T11:46:24.000Z","updated_at":"2025-02-21T09:48:01.000Z","dependencies_parsed_at":"2024-01-13T07:47:33.812Z","dependency_job_id":"79b1541f-dfbe-41f1-8ef7-68320b4f95d9","html_url":"https://github.com/Zaczero/CBBI","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zaczero%2FCBBI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zaczero%2FCBBI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zaczero%2FCBBI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zaczero%2FCBBI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Zaczero","download_url":"https://codeload.github.com/Zaczero/CBBI/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247182338,"owners_count":20897379,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitcoin","confidence-score","cryptocurrency","docker","poetry","price-evaluation","python"],"created_at":"2024-11-21T00:36:48.764Z","updated_at":"2025-04-04T13:09:53.154Z","avatar_url":"https://github.com/Zaczero.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ColinTalksCrypto Bitcoin Bull Run Index (CBBI)\n\n![Python version](https://shields.monicz.dev/badge/python-v3.13-blue)\n[![GitHub Repo stars](https://shields.monicz.dev/github/stars/Zaczero/CBBI?style=social)](https://github.com/Zaczero/CBBI)\n\nThe official Python implementation of the **ColinTalksCrypto Bitcoin Bull Run Index** (CBBI).\n\nThe CBBI is a Bitcoin index that utilizes advanced, real-time analysis of 9 metrics\nto help us understand what stage of the Bitcoin bull run and bear market cycles we are in.\nThe CBBI is time-independent and price-independent.\nIt simply indicates whether it believes we are approaching the top/bottom of a Bitcoin cycle.\n\nIf you want to learn more, [check out this video](https://www.youtube.com/watch?v=bq7djf1n0j4).\n\n## Visit our website\n\nBookmark it and receive latest CBBI updates.\n\n- [CBBI.info](https://cbbi.info/)\n\n## Script Demo\n\n[![asciicast](https://raw.githubusercontent.com/Zaczero/CBBI/main/asciinema/thumbnail.webp)](https://asciinema.org/a/KFkbKPULf9PGvY8Fmh4QLn0FE)\n\n## Docker Usage\n\nTo use the CBBI script with Docker, run the following command:\n\n```sh\ndocker run --rm --pull=always zaczero/cbbi --help\ndocker run --rm --pull=always zaczero/cbbi\n```\n\n## Manual Usage\n\nTo use the CBBI script without Docker, follow these two simple steps:\n\n### 1. Install nix\n\nBefore you jump in, make sure to install the [❄️ Nix](https://nixos.org/download) package manager. It's your shortcut to seamless dependency management and reproducible environment setup. It will save you lots of time and spare you from unnecessary stress.\n\n### 2. Run the application\n\n```sh\nnix-shell --run \"python main.py --help\"\n```\n\n#### or with using interactive shell\n\n```sh\nnix-shell\npython main.py --help\n```\n\n## Metrics\n\nThe current CBBI version _(November 2022)_ includes the following metrics:\n\n| Name                         | Link                                                                  |\n| ---------------------------- | --------------------------------------------------------------------- |\n| Pi Cycle Top Indicator       | [Visit page](https://coinank.com/indexdata/piCycleTop)               |\n| RUPL/NUPL Chart              | [Visit page](https://coinank.com/indexdata/realizedProf)             |\n| RHODL Ratio                  | [Visit page](https://coinank.com/indexdata/rhodlRatio)               |\n| Puell Multiple               | [Visit page](https://coinank.com/indexdata/puellMultiple)            |\n| 2 Year Moving Average        | [Visit page](https://coinank.com/indexdata/year2MA)                  |\n| Bitcoin Trolololo Trend Line | [Visit page](https://www.blockchaincenter.net/bitcoin-rainbow-chart/) |\n| MVRV Z-Score                 | [Visit page](https://coinank.com/indexdata/score)                    |\n| Reserve Risk                 | [Visit page](https://coinank.com/indexdata/reserveRisk)              |\n| Woobull Top Cap vs CVDD      | [Visit page](https://woocharts.com/bitcoin-price-models/)             |\n\n## Environment Variables\n\nThis project supports `.env` files, which provide a convenient way of setting environment variables.\n\nTo use this feature, create a file called `.env` in the project's root directory,\nand add environment variables in the following format:\n\n```sh\nVARIABLE_NAME=value\n```\n\n### GLASSNODE_API_KEY\n\nDefines an API key to be used during GlassNode fallback requests.\nIf unset or empty, a cache fallback will be used instead (via CBBI.info).\n\n#### Example usage\n\n- GLASSNODE_API_KEY=REPLACE_ME\n\n### TELEGRAM_TOKEN, TELEGRAM_CHAT_ID\n\nDefine both variables to receive Telegram notifications about metric errors that occur during the execution.\n\n#### Example usage\n\n- TELEGRAM_TOKEN=REPLACE_ME\n- TELEGRAM_CHAT_ID=123456\n\n## Footer\n\n### Contact me\n\n\u003chttps://monicz.dev/#get-in-touch\u003e\n\n### License\n\nThis project is licensed under the GNU Affero General Public License v3.0.\n\nThe complete license text can be accessed in the repository at [LICENSE](https://github.com/Zaczero/CBBI/blob/main/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzaczero%2Fcbbi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzaczero%2Fcbbi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzaczero%2Fcbbi/lists"}