j7nn7k / HackerNewsAPI

Unofficial Python API for Hacker News.

Home Page:https://github.com/thekarangoel/HNify

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Hacker News API

Unofficial Python API for Hacker News.

Version Downloads

Installation

$ pip install HackerNews

If you love and use HackerNewsAPI, please consider donating via gittip. Any support is appreciated!

Classes

HN

The class that parses the HN page, and builds up all stories.

Methods

get_stories(story_type='') - Returns a list of stories from the passed page of HN. 'story_type' can be: '' = top stories (homepage), 'newest' = most recent stories, 'best' = best stories

Story details (keys of dict)

  • rank - the rank of story on the page
  • story_id - the story's id
  • title - the title of the story
  • is_self - true for self/job stories
  • link - the url it points to (None for self posts)
  • domain - the domain of the link (None for self posts)
  • points - the points/karma on the story
  • submitter - the user who submitted the story
  • submitter_link - the above user profile link
  • published_time - the published time ago
  • num_comments - the number of comments it has
  • comments_link - the link to the comments page

Example

See test_bot.py

Contribute

If you want to add any new features, or improve existing ones, feel free to send a pull request!

Tests

To run the tests locally just install the requirements by running pip install -r requirements.txt.

Then run the command nosetests in the command line from within the projects root directory.

About

Unofficial Python API for Hacker News.

https://github.com/thekarangoel/HNify

License:MIT License


Languages

Language:Python 100.0%