Metadata-Version: 1.1
Name: cavelink
Version: 1.0.0
Summary: Fetch Cavelink data by parsing the webpage of sensors.
Home-page: https://github.com/SebastienPittet/cavelink
Author: Sébastien Pittet
Author-email: sebastien@pittet.org
License: MIT
Description: README
        ======
        
        |Build Status|
        
        About Cave-Link
        ~~~~~~~~~~~~~~~
        
        Cave-link is a radio device able to transmit data from a cave. You can
        add some measurement sensors. The data is consolidated on creator’s
        server (database) and displayed through a webpage where the data is dump
        to, as `this example shows`_.
        
        If you own a Cavelink, you should ask Felix Ziegler to get your
        specific URL, for the sensors you have.
        
        If you know nothing about Cavelink system, the official `website`_ is
        the good place to start. Or maybe, you can also begin with `Wikipedia`_.
        
        What is this repository for?
        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
        
        This python module gather the data by parsing the webpage. You will
        then be able to display the data on your dashboard or store it to your
        own database. I also provide code samples to better explain this -`see
        directory ‘samples’`_-.
        
        How do I get set up?
        ~~~~~~~~~~~~~~~~~~~~
        
        To ensure a proper setup, I recommend the use of virtualenv (but
        optionnal).
        
        ::
        
           sudo apt-get update && sudo apt-get install git python-pip --yes
           mkdir your-project
           cd your-project
           virtualenv venv
           source venv/bin/activate
           sudo pip install cavelink
        
        Then you can use the module that way:
        
        >>> from cavelink import cavelink
        >>> webpage="http://www.cavelink.com/cl/da.php?s=142&g=10&w=1&l=10"
        >>> nb_rows = 5
        >>> sensor=cavelink.Cavelink(webpage,nb_rows)
        >>> for key, value in sensor.getData().items():
        >>>    print(key, cavelink.toHumanTime(key), value, sensor.unit)
        
        >>> print(sensor.station)
        >>> print(sensor.group)
        >>> print(sensor.number)
        >>> print(sensor.unit)
        
        Contribution guidelines
        ~~~~~~~~~~~~~~~~~~~~~~~
        
        Feel free to submit issue or better, some pull requests !
        
        Who do I talk to?
        ~~~~~~~~~~~~~~~~~
        
        `sebastien at pittet dot org`_
        
        .. _this example shows: http://www.cavelink.com/cl/da.php?s=106&g=1&w=0&l=10
        .. _website: http://www.cavelink.com
        .. _Wikipedia: https://de.wikipedia.org/wiki/Cave-Link
        .. _see directory ‘samples’: https://github.com/SebastienPittet/cavelink/tree/master/samples
        .. _sebastien at pittet dot org: https://sebastien.pittet.org
        
        .. |Build Status| image:: https://travis-ci.org/SebastienPittet/cavelink.svg?branch=master
           :target: https://travis-ci.org/SebastienPittet/cavelink
Platform: any
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 2
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
