Metadata-Version: 2.1
Name: BlockFiRates
Version: 0.4.0
Home-page: https://github.com/pgoslatara/blockfirates
Author: P. G. Ó'Slatara
Author-email: pgoslatara@gmail.com
License: MIT
Keywords: crypto,python3,blockfi
Classifier: Environment :: Console
Classifier: Framework :: Flake8
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Python: >=3.7.*,<=3.9.*
Description-Content-Type: text/markdown
Provides-Extra: dev

![PyPI - Python Version](https://img.shields.io/pypi/pyversions/blockfirates)

Scrape the latest APY rates for BlockFi Interest Accounts

# DISCLAIMER

This package is in no way affiliated in any way, shape or form with BlockFi and as such its use is entirely at the user's own risk.

# BlockFiRates

An unofficial API to easily obtain the interest rates of [BlockFi Interest Accounts (BIA)](https://blockfi.com/rates/).

# Getting Started

### Installing
```
pip install blockfirates
```
### Imports
```
from blockfirates import client
Client=client.BlockFiRates()
```

## Available Functions
* get_all_rates
* get_amount
* get_apy

## get_all_rates
Printing info for all currencies:
```
rates = Client.get_all_rates()
for i in rates:
    print(i)
```

## get_amount
Printing amount criteria for a specific currency:
```
Client.get_amount("BTC (Tier 1)")
```

## get_apy
Printing APY rate for a specific currency:
```
Client.get_apy("BTC (Tier 1)")
```

### Development
Create a virtual environment using [virtualenv](https://pypi.org/project/virtualenv/), activate it and install necessary dependencies:
```
python -m virtualenv env
source venv/bin/activate
pip install -r requirements.txt
pip install -r requirements_dev.txt
pip install -e .
```
Once changes have been committed, create and merge to the master branch on Github and push the new version to PyPi:
```
git push -u origin master

python -m build

twine check dist/*

poetry publish --build --username $PYPI_USERNAME --password $PYPI_PASSWORD
```
