Skip to content

Commit d5bed92

Browse files
committed
Update README
1 parent 42d5ccd commit d5bed92

File tree

2 files changed

+47
-10
lines changed

2 files changed

+47
-10
lines changed

README.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@ For the latest version, check out the repo and call
3232
> python bitcoinetl.py
3333
```
3434

35+
[LIMITATIONS](#limitations)
36+
3537
## Table of Contents
3638

3739
- [Schema](#schema)
@@ -40,9 +42,7 @@ For the latest version, check out the repo and call
4042
- [Exporting the Blockchain](#exporting-the-blockchain)
4143
- [Running in Docker](#running-in-docker)
4244
- [Command Reference](#command-reference)
43-
- [Querying in Amazon Athena](#querying-in-amazon-athena)
44-
- [Querying in Google BigQuery](#querying-in-google-bigquery)
45-
- [Public Dataset](#public-dataset)
45+
- [Public Datasets in BigQuery](#public-datasets-in-bigquery)
4646

4747

4848
## Schema
@@ -110,6 +110,12 @@ value | bigint |
110110

111111
You can find column descriptions in [schemas](https://github.com/blockchain-etl/bitcoin-etl-airflow/tree/master/dags/resources/stages/enrich/schemas)
112112

113+
## LIMITATIONS
114+
115+
- output values returned by Dogecoin API have precision loss due to this issue
116+
https://github.com/dogecoin/dogecoin/issues/1558
117+
118+
113119
## Exporting the Blockchain
114120

115121
1. Install python 3.5.3+ https://www.python.org/downloads/
@@ -218,6 +224,7 @@ monotonic https://twitter.com/EvgeMedvedev/status/1073844856009576448. You can f
218224
> export BITCOINETL_BITCOIN_PROVIDER_URI=http://user:pass@localhost:8332
219225
> export BITCOINETL_LITECOIN_PROVIDER_URI=http://user:pass@localhost:8331
220226
> export BITCOINETL_DOGECOIN_PROVIDER_URI=http://user:pass@localhost:8330
227+
> export BITCOINETL_BITCOIN_CASH_PROVIDER_URI=http://user:pass@localhost:8329
221228
> export BITCOINETL_DASH_PROVIDER_URI=http://user:pass@localhost:8328
222229
> export BITCOINETL_ZCASH_PROVIDER_URI=http://user:pass@localhost:8327
223230
> pytest -vv
@@ -230,11 +237,5 @@ monotonic https://twitter.com/EvgeMedvedev/status/1073844856009576448. You can f
230237
> tox
231238
```
232239

233-
## Querying in Amazon Athena
234-
Coming Soon...
235-
236-
## Querying in Google BigQuery
237-
Coming Soon...
238-
239-
### Public Dataset
240+
### Public Datasets
240241
Coming Soon...

pypi.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Uploading to PYPI
2+
3+
Create `$HOME/.pypirc` with the following content:
4+
5+
```
6+
[distutils]
7+
index-servers=
8+
testpypi
9+
pypi
10+
11+
[testpypi]
12+
repository = https://test.pypi.org/legacy/
13+
username = <username>
14+
password = <password>
15+
16+
[pypi]
17+
repository = https://upload.pypi.org/legacy/
18+
username = <username>
19+
password = <password>
20+
```
21+
22+
Run the following to install to test pypi:
23+
24+
```bash
25+
> python setup.py sdist
26+
> twine upload dist/* -r testpypi
27+
> pip install -i https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple bitcoin-etl
28+
```
29+
30+
Run the following to install to pypi:
31+
32+
```bash
33+
> python setup.py sdist
34+
> twine upload dist/*
35+
> pip install bitcoin-etl
36+
```

0 commit comments

Comments
 (0)