Skip to content

Commit

Permalink
add notes about python install to README
Browse files Browse the repository at this point in the history
  • Loading branch information
sslivkoff committed Aug 4, 2023
1 parent 66e5074 commit 8e7a5e9
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Rust](https://github.com/paradigmxyz/cryo/actions/workflows/build_and_test.yml/badge.svg)](https://github.com/paradigmxyz/cryo/actions/workflows/build_and_test.yml)

`cryo` is the easiest way to extract blockchain data to parquet, csv, or json
`cryo` is the easiest way to extract blockchain data to parquet, csv, json, or a python dataframe.

`cryo` is also extremely flexible, with [many different options](#cli-options) to control how data is extracted + filtered + formatted

Expand Down Expand Up @@ -61,6 +61,24 @@ This method requires having rust installed. See [rustup](https://rustup.rs/) for

Make sure that `~/.cargo/bin` is on your `PATH`. One way to do this is by adding the line `export PATH="$HOME/.cargo/bin:$PATH"` to your `~/.bashrc` or `~/.profile`.

#### Installing `cryo_python` from pypi

(make sure rust is installed first, see [rustup](https://www.rust-lang.org/tools/install))

```bash
pip install maturin
pip install cryo_python
```

#### Installing `cryo_python` from source

```bash
pip install maturin
git clone https://github.com/paradigmxyz/cryo
cd cryo/crates/python
maturin build --release
pip install <OUTPUT_OF_MATURIN_BUILD>.whl
```

## Data Schema

Expand Down

0 comments on commit 8e7a5e9

Please sign in to comment.