# Klaytn ETL
Klaytn ETL lets you convert Klaytn blockchain data into convenient formats like JSONs, CSVs and relational databases.
This is a fork of [Ethereum ETL](https://github.com/blockchain-etl/ethereum-etl).
[Full documentation available here](http://klaytn-etl.readthedocs.io/).
***Notice: Klaytn ETL is still on the beta version. However, CLIs are all functional.***
## Quickstart
Install Klaytn ETL:
```bash
pip3 install klaytn-etl-cli
```
Export blocks and transactions
```bash
> klaytnetl export_blocks_and_transactions --start-block 0 --end-block 5000 \
--blocks-output blocks.json --transactions-output transactions.json
```
Export ERC20 and ERC721 transfers
```bash
> klaytnetl export_token_transfers --start-block 0 --end-block 5000 \
--output token_transfers.json
```
Export traces
```bash
> klaytnetl export_traces --start-block 0 --end-block 5000 \
--output traces.json
```
Find other commands [here](klaytnetl/cli/__init__.py).
For the latest version, check out the repo and call
```bash
> pip3 install -e .
> python3 klaytnetl.py
```
### Running in Docker
1. Install Docker https://docs.docker.com/install/
2. Build a docker image
```bash
> docker build -t klaytn-etl:latest .
> docker image ls
```
3. Run a container out of the image
```bash
> docker run -v $HOME/output:/klaytn-etl/output klaytn-etl:latest export_all -s 0 -e 5499999 -b 100000
> docker run -v $HOME/output:/klaytn-etl/output klaytn-etl:latest export_all -s 2018-01-01 -e 2018-01-01
```
Raw data
{
"_id": null,
"home_page": "https://github.com/klaytn/klaytn-etl",
"name": "klaytn-etl-cli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7.2,<4",
"maintainer_email": "",
"keywords": "klaytn,etl,batch",
"author": "Yongchan Hong",
"author_email": "chan.hong@krustuniverse.com",
"download_url": "",
"platform": null,
"description": "# Klaytn ETL\n\nKlaytn ETL lets you convert Klaytn blockchain data into convenient formats like JSONs, CSVs and relational databases.\nThis is a fork of [Ethereum ETL](https://github.com/blockchain-etl/ethereum-etl).\n\n[Full documentation available here](http://klaytn-etl.readthedocs.io/).\n\n***Notice: Klaytn ETL is still on the beta version. However, CLIs are all functional.***\n\n## Quickstart\nInstall Klaytn ETL:\n\n```bash\npip3 install klaytn-etl-cli\n```\n\nExport blocks and transactions\n\n```bash\n> klaytnetl export_blocks_and_transactions --start-block 0 --end-block 5000 \\\n--blocks-output blocks.json --transactions-output transactions.json\n```\n\nExport ERC20 and ERC721 transfers\n\n```bash\n> klaytnetl export_token_transfers --start-block 0 --end-block 5000 \\\n--output token_transfers.json\n```\n\nExport traces\n\n```bash\n> klaytnetl export_traces --start-block 0 --end-block 5000 \\\n--output traces.json\n```\n\nFind other commands [here](klaytnetl/cli/__init__.py).\n\nFor the latest version, check out the repo and call \n```bash\n> pip3 install -e . \n> python3 klaytnetl.py\n```\n\n### Running in Docker\n\n1. Install Docker https://docs.docker.com/install/\n\n2. Build a docker image\n ```bash\n > docker build -t klaytn-etl:latest .\n > docker image ls\n ```\n\n3. Run a container out of the image\n ```bash\n > docker run -v $HOME/output:/klaytn-etl/output klaytn-etl:latest export_all -s 0 -e 5499999 -b 100000\n > docker run -v $HOME/output:/klaytn-etl/output klaytn-etl:latest export_all -s 2018-01-01 -e 2018-01-01\n ```\n",
"bugtrack_url": null,
"license": "",
"summary": "Tools for exporting Klaytn blockchain data to JSON",
"version": "0.3.6",
"split_keywords": [
"klaytn",
"etl",
"batch"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cea78c0369734d08ad015750356f97ec8f4ccc9eaf38c7634fcaef5656eeb517",
"md5": "a015c8bd2df1569a3b453c7b4b5ad470",
"sha256": "ae943f40a08b8ce953cae1357cabe81433635ce754a6e581ec18f785810f3f25"
},
"downloads": -1,
"filename": "klaytn_etl_cli-0.3.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a015c8bd2df1569a3b453c7b4b5ad470",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7.2,<4",
"size": 251273,
"upload_time": "2023-01-26T08:36:14",
"upload_time_iso_8601": "2023-01-26T08:36:14.163629Z",
"url": "https://files.pythonhosted.org/packages/ce/a7/8c0369734d08ad015750356f97ec8f4ccc9eaf38c7634fcaef5656eeb517/klaytn_etl_cli-0.3.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-26 08:36:14",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "klaytn",
"github_project": "klaytn-etl",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "klaytn-etl-cli"
}
JSON
