Metadata-Version: 1.1
Name: zuckup
Version: 0.0.9
Summary: simple facebook parsing
Home-page: http://github.com/newslynx/zuckup
Author: Brian Abelson
Author-email: brian@newslynx.org
License: MIT
Description: |travis-img| zuckup ====== *simple facebook parsing*
        
        Install
        -------
        
        ::
        
            pip install zuckup
        
        Test
        ----
        
        Requires ``nose``
        
        ::
        
            nosetests
        
        Usage
        -----
        
        ``zuckup`` comes with three utilities: ``insights``, ``page``, and
        ``page_stats``
        
        Insights
        ~~~~~~~~
        
        *NOTE*: To get facebook insights data you must first have an access
        token that has necessary credentials to view this data.
        
        .. code:: python
        
            import zuckup
        
            for post_stats in zuckup.insights(page_id='authenticated_page'):
              print post_stats
        
        Page Posts
        ~~~~~~~~~~
        
        .. code:: python
        
            import zuckup
        
            for post in zuckup.page(page_id='nytimes')
              print post 
        
        Page Stats
        ~~~~~~~~~~
        
        .. code:: python
        
            import zuckup
        
            page_stats = zuckup.page_stats(page_id='nytimes')
            print page_stats
        
        Authentication
        --------------
        
        ``zuckup`` will automatically connect to the facebook api via ``facepy``
        if you have ``FB_APP_ID`` and ``FB_APP_SECRET`` set as environmental
        variables.
        
        Alternatively, you can connect beforehand and pass in this connection
        via the kwarg ``conn``:
        
        .. code:: python
        
            import zuckup
        
            conn = zuckup.connect(app_id='12345', app_secret='678910')
        
            page_stats = zuckup.page_stats(page_id='nytimes', conn=conn)
            print page_stats
        
        Finally, if you want to connect with just an access token, say one
        acquired from a user authenticating to your app, pass in
        ``access_token`` to any of the methods:
        
        .. code:: python
        
            import zuckup
        
            page_stats = zuckup.page_stats(page_id='nytimes', access_token='a-users-access-token')
            print page_stats
        
        Pagination
        ----------
        
        paginate through results using ``paginate`` with ``insights`` and
        ``page``:
        
        ::
        
            for post in zuckup.page(page_id='nytimes', paginate=True)
              print post 
        
        Concurrency
        -----------
        
        optional concurrency for ``insights`` and ``page`` via ``gevent``:
        
        ::
        
            import zuckup
        
            for post in zuckup.page(page_id='nytimes', concurrent=True)
              print post 
        
        .. |travis-img| image:: https://travis-ci.org/newslynx/zuckup.svg
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
