Metadata-Version: 2.1
Name: Tilty
Version: 0.2.1
Summary: A pluggable system to receive and transmit bluetooth events from the Tilt Hydrometer
Home-page: UNKNOWN
Author: Marcus Young
Author-email: 3vilpenguin@gmail.com
License: UNKNOWN
Description: Tilty
        =====
        
        A python module and CLI to capture and emit events from your [tilt hydrometer](https://tilthydrometer.com/)
        
        I've been unhappy with the quality/inconsistency of what I've seen out there in terms of random scripts that capture.
        No tests, no pluggable emitters, hard to find, etc.
        
        The tilt essentially broadcasts iBeacon packets to send out a uuid (which type of tilt it is), a major (the temp in F), and a minor (the specific gravity).
        
        This will capture those whenever theyre transmitted and emit them to a backend of your choosing so that you can graph it over time asynchronously.
        
        The Tilt supports writing to a google doc which you could use with something like IFTTT or Zapier, but this is much lighter and lets you decide how you want to push that out with a pluggable backend system.
        
        
        ## Supported Emitters ##
        
        
        * Webhooks
        * InfluxDB
        
        
        ## Usage ##
        
        ### As a cli ###
        
        ```
        $ cat <<EOF >config.ini
        [general]
        sleep_interval = 10
        
        [webhook]
        url = http://www.foo.com
        payload_template = {"color": "{{ color }}", "gravity": {{ gravity }}, "temp": {{ temp }}, "timestamp": "{{ timestamp }}"}
        method = GET
        
        [influxdb]
        url = influxdb.corp.com
        port = 80
        database = tilty
        gravity_payload_template = {"measurement": "gravity", "tags": {"color": "{{ color }}"}, "fields": {"value": {{ gravity }}}}
        temperature_payload_template = {"measurement": "temperature", "tags": {"color": "{{ color }}"}, "fields": {"value": {{ temp }}}}
        EOF
        $ tilty
        ```
        
        ### From docker ###
        
        #### From source ####
        
        ```
        $ git clone https://github.com/myoung34/tilty
        $ docker-compose build
        $ docker-compose run tilty
        ```
        
        #### From the upstream image ####
        
        ```
        $ docker run -it --net=host myoung34/tilty:latest # for x86_64
        $ docker run -it --net=host myoung34/tilty:latest-arm # for ARM
        ```
        
        
        ## Installation ##
        
        ```
        $ git clone https://github.com/myoung34/tilty
        $ pip install -e .
        ```
        
        ## Development ##
        
        ```
        $ docker run -it -v $(pwd):/src -w /src --entrypoint /bin/sh python:3.7-alpine
        $ apk add -U openssl-dev alpine-sdk libffi-dev python3-dev py3-bluez bluez-dev
        $ pip3 install poetry
        $ poetry install
        $ poetry run tox
        ```
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
