# bit-notify
SMS notifier for bittrex
## Installation
```
$ pip install bit-notify
```
### Install from source
```
$ git clone https://github.com/hthompson6/bit-notify.git
$ cd bit-notify
$ python setup.py install -e .
```
## Usage
Please note that this service relies on Twilio. To sign up for Twilio please
visit https://www.twilio.com/try-twilio.
```python
api_key = 'my_bittrex_api_key'
api_sign = 'my_bittrex_api_secret'
account_sid = 'my_twilio_account_sid'
auth_token = 'my_twilio_auth_token'
sender = '<country_code><my_twilio_phone_number>'
reciever = '<country_code><my_personal_phone_number>'
notify = Notifier(api_key, api_sign, account_sid, auth_token, sender, reciever)
notify.start()
notify.kill_thread()
```
### Advanced Usage
Notifications occur when the percent change over a 24hr span of time
lies outside of the given threshold. (Updates to this percentage are
checked every 30 minutes.)
The default is as follows: **-100% < %change < 100%**
To alter the threshold simply modify the class instatiaion:
```python
notify = Notifier(api_key, api_sign, account_sid, auth_token,
sender, reciever, lower_bound=-15, upper_bound=50)
notify.start()
```
SMS notifier for bittrex
## Installation
```
$ pip install bit-notify
```
### Install from source
```
$ git clone https://github.com/hthompson6/bit-notify.git
$ cd bit-notify
$ python setup.py install -e .
```
## Usage
Please note that this service relies on Twilio. To sign up for Twilio please
visit https://www.twilio.com/try-twilio.
```python
api_key = 'my_bittrex_api_key'
api_sign = 'my_bittrex_api_secret'
account_sid = 'my_twilio_account_sid'
auth_token = 'my_twilio_auth_token'
sender = '<country_code><my_twilio_phone_number>'
reciever = '<country_code><my_personal_phone_number>'
notify = Notifier(api_key, api_sign, account_sid, auth_token, sender, reciever)
notify.start()
notify.kill_thread()
```
### Advanced Usage
Notifications occur when the percent change over a 24hr span of time
lies outside of the given threshold. (Updates to this percentage are
checked every 30 minutes.)
The default is as follows: **-100% < %change < 100%**
To alter the threshold simply modify the class instatiaion:
```python
notify = Notifier(api_key, api_sign, account_sid, auth_token,
sender, reciever, lower_bound=-15, upper_bound=50)
notify.start()
```
Metadata
Release files for bit-notify 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| bit_notify-0.1.3-py2-none-any.whl | Python 2 | none | any | Details |
Release files / bit_notify-0.1.3-py2-none-any.whl
| Download URL | bit_notify-0.1.3-py2-none-any.whl |
|---|---|
| Size | 6.0 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
49345984f3f20e3398d65d3c0e565827a2af65ff1fba70153941598361d355e6
|
|
BLAKE2b-256 checksum How to use checksums |
acfff3063cd47bb22924010323cd15bcd27bb6079955fd502d0067b65add2bf4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |