Welcome to IOTA Balance Change Alert’s documentation!

Contents:

IOTA Balance Change Alert

https://img.shields.io/pypi/v/iota_balance_change_alert.svg https://img.shields.io/travis/plenarius/iota_balance_change_alert.svg Documentation Status Updates

IOTA Balance Change Alert checks the balance on one or more addresses at a specified interval and alerts the user if there’s any change in balance.

Features

  • Users can be alerted via text message, email, popup or system sound

Installation

To install IOTA Balance Change Alert, run this command in your terminal:

$ pip install iota_balance_change_alert
$ mkdir $HOME/.ibca && wget https://raw.githubusercontent.com/plenarius/iota_balance_change_alert/master/config.ini.example -O $HOME/.ibca/config.ini

If you want to be informed via text message you need to sign up for a free Twilio acccount at https://www.twilio.com and get their python library

$ pip install twilio

Usage

Make sure to edit your config.ini to include your desired IOTA addresses and methods of alert. You do not need to specify the location of your config file if it’s installed in $HOME/.ibca/config.ini.

$ iota_balance_change_alert --config path/to/config.ini

Credits

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation

Stable release

To install IOTA Balance Change Alert, run this command in your terminal:

$ pip install iota_balance_change_alert

This is the preferred method to install IOTA Balance Change Alert, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for IOTA Balance Change Alert can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/plenarius/iota_balance_change_alert

Or download the tarball:

$ curl  -OL https://github.com/plenarius/iota_balance_change_alert/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

Usage: iota_balance_change_alert [OPTIONS]

Options:
--config PATH Specify the path to your config file, default is $HOME/.ibca/config.ini
--help Show this message and exit.

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/plenarius/iota_balance_change_alert/issues.

If you are reporting a bug, please include:

  • Your operating system name and version.
  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

IOTA Balance Change Alert could always use more documentation, whether as part of the official IOTA Balance Change Alert docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/plenarius/iota_balance_change_alert/issues.

If you are proposing a feature:

  • Explain in detail how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up iota_balance_change_alert for local development.

  1. Fork the iota_balance_change_alert repo on GitHub.

  2. Clone your fork locally:

    $ git clone git@github.com:your_name_here/iota_balance_change_alert.git

  3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

    $ mkvirtualenv iota_balance_change_alert
$ cd iota_balance_change_alert/
$ python setup.py develop

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

    $ flake8 iota_balance_change_alert tests
$ python setup.py test or py.test
$ tox

    To get flake8 and tox, just pip install them into your virtualenv.

  6. Commit your changes and push your branch to GitHub:

    $ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature

  7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include tests.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.7, 3.5 and 3.6, and for PyPy. Check https://travis-ci.org/plenarius/iota_balance_change_alert/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ python -m unittest tests.test_iota_balance_change_alert

Credits

Development Lead

Contributors

None yet. Why not be the first?

History

0.1.2 (2017-12-23)

  • Minor bugfix to email notifications
  • Added some more documentation

0.1.1 (2017-12-11)

  • First release on PyPI.

0.1.0 (2017-12-11)

  • First release on github.

Indices and tables