Metadata-Version: 1.1
Name: chirimbolito
Version: 0.dev7
Summary: A Bitcoin address monitoring tool built with a Raspberry Pi and a LCD display
Home-page: https://github.com/facastagnini/python-chirimbolito
Author: Federico Ariel Castagnini
Author-email: federico.castagnini@protonmail.com
License: UNKNOWN
Description-Content-Type: UNKNOWN
Description: ============
        Chirimbolito
        ============
        
        .. image:: https://api.codacy.com/project/badge/Grade/09b74b48abd44905892de63270b0e77d
           :target: https://www.codacy.com/app/facastagnini_2/chirimbolito
        .. image:: https://badge.fury.io/py/chirimbolito.svg
           :target: https://badge.fury.io/py/chirimbolito
        
        A Bitcoin address monitoring tool built with a Raspberry Pi and a LCD display
        
        *************
        You will need
        *************
        
        - one Raspberry Pi
        - one micro SD card
        - one LCD screen, `Adafruit RGB Negative 16x2 LCD+Keypad Kit for Raspberry Pi <https://www.adafruit.com/product/1110>`_
        - one or more bitcoin address to monitor
        
        ***************
        How to build it
        ***************
        
        - Install Raspbian Stretch Lite on the micro SD card. This is beyond the scope of this document, you can find a good guide `here <https://www.raspberrypi.org/downloads/raspbian/>`_
        - `Enable sshd on a headless Raspberry Pi <https://www.raspberrypi.org/documentation/remote-access/ssh/>`_
        - Install the LCD screen and the micro SD card in the Raspberry Pi
        - Boot the Raspberry Pi
        - ssh into the Raspberry Pi and install the bitcoin address monitoring tool
        
            ssh pi@raspbian
        
            password: (the default password is 'raspberry')
        
            pi@raspbian ~ $ sudo apt-get update && sudo apt-get install build-essential python3 python3-dev python3-smbus python3-pip i2c-tools
        
            pi@raspbian ~ $ sudo pip install --upgrade pip
            
            pi@raspbian ~ $ sudo /usr/sbin/usermod -a -G i2c pi
            
            pi@raspbian ~ $ mkdir chirimbolito
            
            pi@raspbian ~ $ virtualenv chirimbolito
            
            pi@raspbian ~ $ cd chirimbolito
            
            pi@raspbian ~/chirimbolito $ source bin/activate
            
            (chirimbolito) pi@raspbian ~/chirimbolito $ pip install chirimbolito
        
        - Edit the file `~/.config/chirimbolito.json` to configure the bitcoin addresses that you want to monitor.
        
        
        *************
        CONTRIBUITING
        *************
        Contributions gladly accepted, just open a ticket or send a PR :)
        
        *********
        PACKAGING
        *********
        
            export VERSION='0.dev7'
        
            # bump the $VERSION in setup.py
        
            python3 setup.py sdist
            
            python3 setup.py bdist_wheel
            
            gpg --detach-sign -a dist/chirimbolito-$VERSION.tar.gz
            
            gpg --detach-sign -a dist/chirimbolito-$VERSION-py2-none-any.whl
            
            python3 twine upload --repository pypi dist/*
            
            git tag -s $VERSION
            
            git push --tags
        
Keywords: raspberry pi rpi bitcoin lcd wallet monitoring
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
