Metadata-Version: 1.0
Name: OnionPy
Version: 0.1.6
Summary: Python wrapper for the OnionOO tor status API
Home-page: http://github.com/duk3luk3/onion-py
Author: Lukas Erlacher
Author-email: tor@lerlacher.de
License: UNKNOWN
Description: OnionPy
        ========
        
        A comprehensive pure-Python wrapper for the OnionOO Tor status API, with memcached support to cache queried data.
        
        Installing OnionPy
        ===================
        
        You can install onion-py manually by doing the following (requires setuptools!)::
        
            git clone https://github.com/duk3luk3/onion-py.git
            cd onion-py
            #run tests if desired
            PYTHONPATH=. python bin/onion.py test
            sudo python setup.py install
        
        For the optional memcached support, install pymemcache and six::
        
            sudo pip install six
            sudo pip install https://github.com/pinterest/pymemcache.git
        
        The package is also on [Pypi](https://pypi.python.org/pypi/OnionPy).
        
        **Beware**: <del>OnionPy has been developed and tested exclusively with Python 3. Please let Python 2 rest in peace forevermore.</del> OnionPy is compatible with Python 2.7 upwards.
        
        Usage
        =====
        
            >>> from onion_py.manager import Manager
            >>> from onion_py.caching import OnionSimpleCache
            >>> manager = Manager(OnionSimpleCache())
            >>> s = manager.query('summary', limit=4)
            >>> s.relays[0].fingerprint
            '695D027F728A3B95D0D7F6464D63F82229BFA361'
            >>> s.relays[0].nickname
            'GREATWHITENORTH'
        
        License
        =======
        
        BSD 3-clause. See LICENSE.  
        Portions of this work obviously belong to to OnionOO and therefore the Tor Project. See ONIONOO-LICENSE.
        
Platform: UNKNOWN
