Hacker News Top
==============

[![Build Status](https://travis-ci.org/rylans/hackernews-top.svg?branch=master)](https://travis-ci.org/rylans/hackernews-top)

Unofficial Python wrapper over Hacker News' official Firebase API.

### Install

```
> git clone https://github.com/rylans/hackernews-top.git
> cd hackernews-top
> pip install .
```

### Usage

```
>>> from hnapi.connectors.api_connector import ApiConnector
>>> con = ApiConnector()
>>> item = con.get_item(8863)
>>> item.get('title')
u'My YC app: Dropbox - Throw away your USB drive'
>>> item.get('by')
u'dhouston'
```

### Roadmap

* Item types:
  * Story **Partial support**
  * Comment
  * Job
  * Ask HN
  * Poll
* User **Partial support**
* API calls
  * ~~`v0/item`~~ **Done**
  * ~~`v0/user`~~ **Done**
  * ~~`v0/topstories`~~ **Done**
  * `v0/maxitem` **Partial support**
  * `v0/updates`
* Schema assertions

### Statistical Data

![Domain Frequency](diagrams/frequency_bar.png)

### License

Apache

Hacker News Top
==============

[![Build Status](https://travis-ci.org/rylans/hackernews-top.svg?branch=master)](https://travis-ci.org/rylans/hackernews-top)

Unofficial Python wrapper over Hacker News' official Firebase API.

### Install

```
> git clone https://github.com/rylans/hackernews-top.git
> cd hackernews-top
> pip install .
```

### Usage

```
>>> from hnapi.connectors.api_connector import ApiConnector
>>> con = ApiConnector()
>>> item = con.get_item(8863)
>>> item.get('title')
u'My YC app: Dropbox - Throw away your USB drive'
>>> item.get('by')
u'dhouston'
```

### Roadmap

* Item types:
  * Story **Partial support**
  * Comment **Partial support**
  * Job
  * Ask HN
  * Poll
* User **Partial support**
* API calls
  * ~~`v0/item`~~ **Done**
  * ~~`v0/user`~~ **Done**
  * ~~`v0/topstories`~~ **Done**
  * `v0/maxitem` **Partial support**
  * ~~`v0/updates`~~ **Done**
* Schema assertions

### Statistical Data

![Domain Frequency](diagrams/frequency_bar.png)

### License

Apache

Update readme with completion info
Update readme with completion info
