Skip to main content

Bittrex SMS Notifier

Project description

# 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()
```


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bit_notify-0.1.3-py2-none-any.whl (6.0 kB view details)

Uploaded Python 2

File details

Details for the file bit_notify-0.1.3-py2-none-any.whl.

File metadata

File hashes

Hashes for bit_notify-0.1.3-py2-none-any.whl
Algorithm Hash digest
SHA256 49345984f3f20e3398d65d3c0e565827a2af65ff1fba70153941598361d355e6
MD5 04423a01580b93842840ed187ee4cca9
BLAKE2b-256 acfff3063cd47bb22924010323cd15bcd27bb6079955fd502d0067b65add2bf4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page