{"id":27443883,"url":"https://github.com/josephmachado/bitcoinmonitor","last_synced_at":"2025-04-15T02:58:04.699Z","repository":{"id":41237555,"uuid":"384816308","full_name":"josephmachado/bitcoinMonitor","owner":"josephmachado","description":"Near real time ETL to populate a dashboard.","archived":false,"fork":false,"pushed_at":"2024-06-17T17:58:26.000Z","size":1398,"stargazers_count":73,"open_issues_count":0,"forks_count":41,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-15T02:58:01.402Z","etag":null,"topics":["cron","docker","docker-compose","etl-pipeline","metabase","nearrealtime","postgres","pytest","python3"],"latest_commit_sha":null,"homepage":"https://www.startdataengineering.com/post/data-engineering-project-to-impress-hiring-managers/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/josephmachado.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-10T23:16:59.000Z","updated_at":"2025-02-04T18:37:11.000Z","dependencies_parsed_at":"2024-06-17T19:40:23.865Z","dependency_job_id":"f2c3e33f-1b9e-43f3-9feb-551597d8428c","html_url":"https://github.com/josephmachado/bitcoinMonitor","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/josephmachado%2FbitcoinMonitor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/josephmachado%2FbitcoinMonitor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/josephmachado%2FbitcoinMonitor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/josephmachado%2FbitcoinMonitor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/josephmachado","download_url":"https://codeload.github.com/josephmachado/bitcoinMonitor/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248997095,"owners_count":21195797,"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":["cron","docker","docker-compose","etl-pipeline","metabase","nearrealtime","postgres","pytest","python3"],"created_at":"2025-04-15T02:58:04.197Z","updated_at":"2025-04-15T02:58:04.689Z","avatar_url":"https://github.com/josephmachado.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n\n* [Bitcoin Monitor](#bitcoin-monitor)\n    * [Run Data Pipeline](#run-data-pipeline)\n        * [Run on codespaces](#run-on-codespaces)\n        * [Run locally](#run-locally)\n    * [Architecture](#architecture)\n\n# Bitcoin Monitor\n\nThis is an ETL pipeline to pull bitcoin exchange data from [CoinCap API](https://docs.coincap.io/) and load it into our data warehouse. For more details check out the blog at https://startdataengineering.com/post/data-engineering-project-to-impress-hiring-managers/\n\n## Run Data Pipeline\n\nCode available at **[bitcoinMonitor](https://github.com/josephmachado/bitcoinMonitor/tree/main)** repository.\n\n### Run on codespaces\n\nYou can run this data pipeline using GitHub codespaces. Follow the instructions below.\n\n1. Create codespaces by going to the **[bitcoinMonitor](https://github.com/josephmachado/bitcoinMonitor/tree/main)** repository, forking it and then clicking on `Create codespaces on main` button.\n2. Wait for codespaces to start, then in the terminal type `make up`.\n3. Wait for `make up` to complete, and then wait for 30s (give Metabase sometime to setup).\n4. After 30s go to the `ports` tab and click on the link exposing port `3000` to access Metabase UI (username and password is `sdeuser` and `sdepassword1234` respectively). See `metabase connection settings` screenshot below for connection details.\n\n**Note**: The screenshots show how to run a project on codespaces, please make sure to use the instructions above for this specific project.\n\n![codespaces start](./assets/images/cs1.png)\n![codespaces make up](./assets/images/cs2.png)\n![codespaces open url](./assets/images/cs3.png)\n\n**Metabase connection settings:**\n![metabase setup](./assets/images/c.png)\n\nThe metabase UI will look like the following\n![metabase UI](./assets/images/md.png)\n\n**Note** Make sure to switch off codespaces instance, you only have limited free usage; see docs [here](https://github.com/features/codespaces#pricing).\n\n### Run locally\n\nTo run locally, you need:\n\n1. [git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)\n2. [Github account](https://github.com/)\n3. [Docker](https://docs.docker.com/engine/install/) with at least 4GB of RAM and [Docker Compose](https://docs.docker.com/compose/install/) v1.27.0 or later\n\nClone the repo and run the following commands to start the data pipeline:\n\n```bash\ngit clone https://github.com/josephmachado/bitcoinMonitor.git\ncd bitcoinMonitor\nmake up\nsleep 30 # wait for Metabase to start\nmake ci # run checks and tests\n```\nGo to [http:localhost:3000](http:localhost:3000) to see the Metabase UI.\n\n\n## Architecture\n\n![Arch](assets/images/bc_arch.png)\n\nWe use python to pull, transform and load data. Our warehouse is postgres. We also spin up a Metabase instance for our presentation layer.\n\nAll of the components are running as docker containers.\n\nRead **[this post](https://www.startdataengineering.com/post/data-engineering-projects-with-free-template/)**, for information on setting up CI/CD, IAC(terraform), \"make\" commands and automated testing.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjosephmachado%2Fbitcoinmonitor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjosephmachado%2Fbitcoinmonitor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjosephmachado%2Fbitcoinmonitor/lists"}