Metadata-Version: 1.1
Name: haxor
Version: 0.1.0
Summary: Unofficial Python wrapper for Hacker News API
Home-page: https://github.com/avinassh/haxor/
Author: Avinash Sajjanshetty
Author-email: a@sajjanshetty.com
License: MIT
Description: haxor
        =====
        
        Unofficial Python wrapper for official Hacker News API.
        
        Installation
        ------------
        
        ::
        
            pip install haxor
        
        Usage
        -----
        
        import and initialization:
        
        ::
        
            from hackernews import HackerNews
            hn = HackerNews()
        
        Get certain user info by user id (i.e. username on Hacker News)
        
        ::
        
            user = hn.get_user('pg')
            # >>> user.user_id
            # pg
            # >>> user.karma
            # 155040
        
        Stories, comments, jobs, Ask HNs and even polls are just items and they
        have unique item id. To get info of an item by item id:
        
        ::
        
            item = hn.get_item(8863)
            # >>> item.title
            # "My YC app: Dropbox - Throw away your USB drive"
            # >>> item.type
            # story
            # >>> item.kids
            # [ 8952, 9224, 8917, ...]
        
        To get item ids of current top stories:
        
        ::
        
            top_story_ids = hn.top_stories()
            # >>> top_story_ids
            # [8432709, 8432616, 8433237, ...]
        
        To get current largest item id:
        
        ::
        
            max_item = hn.get_max_item()
            # >>> max_item
            # 8433746
        
        Example usage:
        
        ::
        
            for story in hn.top_stories(limit=3):
                print hn.get_item(story)
        
            # 8432709: Redis cluster, no longer vaporware
            # 8432423: Fluid Actuators from Disney Research Make Soft, Safe Robot Arms
            # 8433237: Is Capturing Carbon from the Air Practical?
        
        API Reference
        -------------
        
        Class: ``HackerNews``
        ---------------------
        
        ``get_item``
        ^^^^^^^^^^^^
        
        Description: Returns ``Item`` object
        
        **Parameters:**
        
        +---------------+--------------+------------+----------------------------------------------------+-----------+
        | Name          | Type         | Required   | Description                                        | Default   |
        +===============+==============+============+====================================================+===========+
        | ``item_id``   | string/int   | Yes        | unique item id of Hacker News story, comment etc   | None      |
        +---------------+--------------+------------+----------------------------------------------------+-----------+
        
        ``get_user``
        ^^^^^^^^^^^^
        
        Description: Returns ``User`` object
        
        **Parameters:**
        
        +---------------+----------+------------+----------------------------------------+-----------+
        | Name          | Type     | Required   | Description                            | Default   |
        +===============+==========+============+========================================+===========+
        | ``user_id``   | string   | Yes        | unique user id of a Hacker News user   | None      |
        +---------------+----------+------------+----------------------------------------+-----------+
        
        ``top_stories``
        ^^^^^^^^^^^^^^^
        
        Description: Returns list of item ids of current top stories
        
        **Parameters:**
        
        +-------------+--------+------------+--------------------------------------------------+-----------+
        | Name        | Type   | Required   | Description                                      | Default   |
        +=============+========+============+==================================================+===========+
        | ``limit``   | int    | No         | specifies the number of stories to be returned   | None      |
        +-------------+--------+------------+--------------------------------------------------+-----------+
        
        ``get_max_item``
        ^^^^^^^^^^^^^^^^
        
        Description: Returns current largest item id
        
        Class: ``Item``
        ---------------
        
        From `Official HackerNews Item`_:
        
        +--------------------+-------------------------------------------------------------------------------------------------------------------+
        | Property           | Description                                                                                                       |
        +====================+===================================================================================================================+
        | item\_id           | The item’s unique id.                                                                                             |
        +--------------------+-------------------------------------------------------------------------------------------------------------------+
        | deleted            | ``true`` if the item is deleted.                                                                                  |
        +--------------------+-------------------------------------------------------------------------------------------------------------------+
        | item\_type         | The type of item. One of “job”, “story”, “comment”, “poll”, or “pollopt”.                                         |
        +--------------------+-------------------------------------------------------------------------------------------------------------------+
        | by                 | The username of the item’s author.                                                                                |
        +--------------------+-------------------------------------------------------------------------------------------------------------------+
        | submission\_time   | Creation date of the item, in Python ``datetime``.                                                                |
        +--------------------+-------------------------------------------------------------------------------------------------------------------+
        | text               | The comment, Ask HN, or poll text. HTML.                                                                          |
        +--------------------+-------------------------------------------------------------------------------------------------------------------+
        | dead               | ``true`` if the item is dead.                                                                                     |
        +--------------------+-------------------------------------------------------------------------------------------------------------------+
        | parent             | The item’s parent. For comments, either another comment or the relevant story. For pollopts, the relevant poll.   |
        +--------------------+-------------------------------------------------------------------------------------------------------------------+
        | kids               | The ids of the item’s comments, in ranked display order.                                                          |
        +--------------------+-------------------------------------------------------------------------------------------------------------------+
        | url                | The URL of the story.                                                                                             |
        +--------------------+-------------------------------------------------------------------------------------------------------------------+
        | score              | The story’s score, or the votes for a pollopt.                                                                    |
        +--------------------+-------------------------------------------------------------------------------------------------------------------+
        | title              | The title of the story or poll.                                                                                   |
        +--------------------+-------------------------------------------------------------------------------------------------------------------+
        | parts              | A list of related pollopts, in display order.                                                                     |
        +--------------------+-------------------------------------------------------------------------------------------------------------------+
        | raw                | original JSON response.                                                                                           |
        +--------------------+-------------------------------------------------------------------------------------------------------------------+
        
        Class: ``User``
        ---------------
        
        From `Official HackerNews User`_:
        
        +-------------+------------------------------------------------------------------------------------+
        | Property    | Description                                                                        |
        +=============+====================================================================================+
        | user\_id    | The user’s unique username. Case-sensitive.                                        |
        +-------------+------------------------------------------------------------------------------------+
        | delay       | Delay in minutes between a comment’s creation and its visibility to other users.   |
        +-------------+------------------------------------------------------------------------------------+
        | created     | Creation date of the user, in Python ``datetime``.                                 |
        +-------------+------------------------------------------------------------------------------------+
        | karma       | The user’s karma.                                                                  |
        +-------------+------------------------------------------------------------------------------------+
        | about       | The user’s optional self-description. HTML.                                        |
        +-------------+------------------------------------------------------------------------------------+
        | submitted   | List of the user’s stories, polls and comments.                                    |
        +-------------+------------------------------------------------------------------------------------+
        | raw         | original JSON response.                                                            |
        +-------------+------------------------------------------------------------------------------------+
        
        LICENSE
        -------
        
        MIT
        
        .. _Official HackerNews Item: https://github.com/HackerNews/API/blob/master/README.md#items
        .. _Official HackerNews User: https://github.com/HackerNews/API/blob/master/README.md#users
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
