README, how to run, what you will see

This commit is contained in:
8go
2020-06-15 19:37:12 +00:00
committed by GitHub
parent 3e1a01c271
commit 59fbac1359

View File

@@ -1,2 +1,38 @@
# bitcoin-stock-to-flow
# :star: bitcoin-stock-to-flow :star:
Stock-to-Flow ratio and price for Bitcoin
`s2f.py` is a small Python program to pull data from internet sources (messari.io and coinmetrics.io) to disply the Bitcoin stock-to-flow ratio and price.
If desired rename `s2f.py` to `s2f`.
Example output of `s2f.py`:
```
Data sources: messari.io and coinmetrics.io
Calculated for date: 2020-06-15
Circulating BTC: 18,411,899 BTC
Annual inflation: 1.83 %
Forward stock-to-flow ratio: 54.75
Forward stock-to-flow price: 98,163 USD
Stock-to-flow ratio: 27.03
Stock-to-flow price: 9,556 USD
```
Example output of `s2f.py --verbose`:
```
This program prints the Bitcoin Stock-to-Flow ratio and price.
Read about Stock-to-Flow here: https://medium.com/@100trillionUSD/efficient-market-hypothesis-and-bitcoin-stock-to-flow-model-db17f40e6107
Compare with Stock-to-Flow data: https://bitcoin.clarkmoody.com/dashboard/
Compare with Stock-to-Flow graph: https://digitalik.net/btc/
Data sources: messari.io and coinmetrics.io
Calculated for date: 2020-06-15
Circulating BTC: 18,411,899 BTC
Annual inflation: 1.83 %
Forward stock-to-flow ratio: 54.75
Forward stock-to-flow price: 98,163 USD
Stock-to-flow ratio: 27.03
Stock-to-flow price: 9,556 USD
```
</> with :heart: and available on :octocat: