README, how to run, what you will see

This commit is contained in:
8go
2020-06-16 06:11:36 +00:00
committed by GitHub
parent 5d985954ea
commit 190dc487c8

View File

@@ -1,9 +1,18 @@
# :star: bitcoin-stock-to-flow :star:
Stock-to-Flow ratio and price for Bitcoin
`s2f.py` is a small 1-file-only Python program to pull data from internet sources (messari.io and coinmetrics.io) to disply the Bitcoin stock-to-flow ratio and price.
`s2f.py` is a small 1-file-only Python program to pull data from internet sources (https://messari.io and https://coinmetrics.io) to disply the Bitcoin stock-to-flow ratio and price.
If desired rename `s2f.py` to `s2f`.
### What is Bitcoin Stock-to-Flow?
Stock-to-Flow (S2F, STF) is an economic model. Read more about it here:
- https://en.wikipedia.org/wiki/Stock_and_flow
- https://medium.com/@100trillionUSD/efficient-market-hypothesis-and-bitcoin-stock-to-flow-model-db17f40e6107
- https://bitcoin.clarkmoody.com/dashboard/
- https://digitalik.net/btc/
### How to run?
If desired rename `s2f.py` to `s2f`. Just type `s2f.py` into your terminal.
Example output of `s2f.py`:
@@ -14,8 +23,8 @@ 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
463-day Stock-to-flow ratio: 27.03
463-day Stock-to-flow price: 9,556 USD
```
Example output of `s2f.py --verbose`:
@@ -31,8 +40,8 @@ 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
463-day Stock-to-flow ratio: 27.03
463-day Stock-to-flow price: 9,556 USD
```
</> with :heart: and available on :octocat:. PRs welcome.