Skip to main content

A python module for pulling data from a backloggery account in a variety of different formats

Project description

backlog_puller
==============

*Formerly `backloggery-puller`*

`backlog_puller` is a simple python module that can pull a user's complete video game backlog from [The Backloggery](http://www.backloggery.com) given a username. The results can be returned in XML and JSON format as well as a regular ole' python object.

Setup
=====

Make sure you have python 2.7.x installed.

That's it! The `backloggery-puller` module only relies on The Python Standard Library to work properly. Other versions of Python 2 might work, but they haven't been tested.

Installation
============

You can install `backlog_puller` from PyPi with the following command:

`pip install backlog_puller`

When `backlog_puller` is installed the `backlog_pull` command is also installed. Simply enter:

`backlog_pull {username}`

on your terminal of choice and you will get a JSON representation of that user's backlog.

Usage
=====

`backloggery-puller` consists of two major components: A GamesRequest that pulls the raw HTML from The Backloggery, and the BacklogHTMLParser that converts the raw html into more useful output.

**For example:**
```python
import backloggery_puller

request = GamesRequest("username")
parser = BacklogHTMLParser()
parser.feed(request.get_raw_page())
print parser.backlog
```

Will create a `GamesRequest` for the user `"username"` and feed it into a `BacklogHTMLParser` where it will be stored as a python dictionary. The `BacklogHTMLParser` can then output the parsed data as XML, JSON, or a serialized Python object.

Feature List/Todos
==================

- [X] Retrieve HTML containing entire backlog
- [X] Retrieve one page of HTML
- [X] Retrieve subsequent page with no overlap
- [X] Retrieve pages until the end is reached
- [ ] Parse HTML to more useful formats
- [X] Pull basic data from raw HTML
- [X] Pull game name
- [X] Pull completion status
- [X] Pull game console name
- [ ] Pull advanced data from raw HTML
- [X] Format basic data into XML
- [X] Format basic data into JSON
- [ ] Format basic data into CSV

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
backlog_puller-1.0.0-py2-none-any.whl (7.1 kB) Copy SHA256 hash SHA256 Wheel py2
backlog_puller-1.0.0.zip (7.5 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page