Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs: enhance README with system requirements and usage examples #508

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

docs: enhance README with system requirements and usage examples #508

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 38 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,29 @@
[![Telegram](https://img.shields.io/badge/telegram-join%20chat-blue.svg)](https://t.me/BlockchainETL)
[![Discord](https://img.shields.io/badge/discord-join%20chat-blue.svg)](https://discord.gg/tRKG7zGKtF)

Ethereum ETL lets you convert blockchain data into convenient formats like CSVs and relational databases.
## Overview

*Do you just want to query Ethereum data right away? Use the [public dataset in BigQuery](https://console.cloud.google.com/marketplace/details/ethereum/crypto-ethereum-blockchain).*
Ethereum ETL is a powerful tool for extracting data from the Ethereum blockchain and converting it into convenient formats like CSVs and relational databases. The project enables:

- Exporting blocks, transactions and tokens
- Tracking ERC20 and ERC721 transfers
- Extracting smart contracts and their ABIs
- Real-time data streaming
- Integration with popular data analysis tools

*Want to start querying Ethereum data right away? Use the [public dataset in BigQuery](https://console.cloud.google.com/marketplace/details/ethereum/crypto-ethereum-blockchain).*

[Full documentation available here](http://ethereum-etl.readthedocs.io/).

## Quickstart
## System Requirements

- Python 3.6 or higher
- pip3
- Access to Ethereum node (local or through provider like Infura)
- Minimum 2GB RAM for basic operations
- SSD storage recommended for data

## Quick Start

Install Ethereum ETL:

Expand Down Expand Up @@ -59,6 +75,25 @@ For the latest version, check out the repo and call
> python3 ethereumetl.py
```

## Data Usage Examples

Ethereum ETL enables various types of analysis:

1. Address activity tracking
2. Gas price analysis and dynamics
3. Token activity monitoring
4. Smart contract research
5. Dashboard and visualization creation

Example BigQuery query:
```sql
SELECT DATE(block_timestamp) as date,
COUNT(*) as tx_count
FROM `bigquery-public-data.crypto_ethereum.transactions`
GROUP BY date
ORDER BY date
```

## Useful Links

- [Schema](https://ethereum-etl.readthedocs.io/en/latest/schema/)
Expand Down