Metadata-Version: 2.1
Name: moneyonchain_prices_source
Version: 0.6.6
Summary: Prices source for MoC projects
Author: Juan S. Bokser
Author-email: juan.bokser@moneyonchain.com
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: click
Requires-Dist: tabulate
Requires-Dist: requests
Requires-Dist: influxdb
Requires-Dist: redis
Requires-Dist: bs4
Requires-Dist: lxml
Requires-Dist: web3
Requires-Dist: setuptools>=38.6.0
Requires-Dist: wheel>=0.31.0
Requires-Dist: twine>=1.11.0

# **MoC prices source**

This is the python package used in [**Money on Chain**](https://moneyonchain.com/) projects where it is required to get the coinpair values directly from the sources.
This package includes a CLI tool that allows you to query the coinpair values in the same way that [**Money on Chain**](https://moneyonchain.com/) projects do.



## How to use it in your project

A simple example, do some imports first

```python
user@host:~$ python3
Python 3.8.5 (default, Jul 28 2020, 12:59:40) 
[GCC 9.3.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from moc_prices_source import get_price, BTC_USD
>>>
```

Get de `BTC/USD` coin pair

```python
>>> get_price(BTC_USD)
Decimal('29395.82')
>>> 
```

And that's it!

More [usage examples](https://github.com/money-on-chain/moc_prices_source/blob/v0.6.6/docs/examples.md) can be seen [here](https://github.com/money-on-chain/moc_prices_source/blob/v0.6.6/docs/examples.md)



## How the included CLI tool looks like

Here you can see how the output of the `moc_prices_source_check` command looks like

```shell
user@host:~$ moc_prices_source_check "BTC/USD"

From     To      V.    Exchnage    Response        Weight    %  Time
-------  ------  ----  ----------  ------------  --------  ---  ------
Bitcoin  Dollar        Bitfinex    $  29.45100K      0.18   18  0.9s
Bitcoin  Dollar        Bitstamp    $  29.39500K      0.22   22  0.9s
Bitcoin  Dollar        Coinbase    $  29.39194K      0.25   25  0.71s
Bitcoin  Dollar        Gemini      $  29.40548K      0.17   17  1.09s
Bitcoin  Dollar        Kraken      $  29.38410K      0.18   18  0.71s

    Coin pair      Mediam     Mean    Weighted median    Sources
--  -----------  --------  -------  -----------------  ---------
↓   BTC/USD         29395  29405.5              29395          5

Response time 1.1s

user@host:~$ 
```

This command has many options. you can run `moc_prices_source_check --help` to get help on how to run them.
More information about this CLI tool can be seen [here](https://github.com/money-on-chain/moc_prices_source/blob/v0.6.6/docs/cli.md).



## References

* [Source code in Github](https://github.com/money-on-chain/moc_prices_source/tree/v0.6.6)
* [Package from Python package index (PyPI)](https://pypi.org/project/moneyonchain-prices-source)



## Requirements

* Python 3.6+ support



## Installation

### From the Python package index (PyPI) 

Run:

```shell
$ pip3 install moneyonchain-prices-source 
```

And then run:

```shell
$ moc_prices_source_check --version
```

To verify that it has been installed correctly

### From source

Download from [Github](https://github.com/money-on-chain/moc_prices_source/tree/v0.6.6)

Standing inside the folder, run:

```shell
$ pip3 install -r requirements.txt 
```

For install the dependencies and then run:

```shell
$ pip3 install .
```

Finally run:

```shell
$ moc_prices_source_check --version
```

To verify that it has been installed correctly



## Supported coinpairs and symbols

[Here](https://github.com/money-on-chain/moc_prices_source/blob/v0.6.6/docs/supported_coinpairs.md) you can find an [summary of supported coinpairs and symbols](https://github.com/money-on-chain/moc_prices_source/blob/v0.6.6/docs/supported_coinpairs.md)

