skip to navigation
skip to content

Not Logged In

boardgamegeek 0.0.7

A Python interface to boardgamegeek.com's API

Latest Version: 0.10.1

Introduction

boardgamegeek is a Python library which makes it easy to access data off BoardGameGeek using their official XML API.

It’s an almost completely rewritten fork of libBGG.

Warning

The module’s API is still considered unstable at this point and it might change in the future, especially if wanting to add support for the other sites.

Features

This library exposes (as Python objects with properties) the following BoardGameGeek entities:

  • Users
  • Games
  • User collections
  • Player guilds

requests-cache is used for locally caching replies in order to reduce the amount of requests sent to the server.

Warning

At the moment, the cache is enabled by default and it’s configured to save data in an Sqlite database in the current directory.

Quick Install

To install boardgamegeek, just use pip:

> pip install boardgamegeek

Documentation

Documentation is available at http://boardgamegeek.readthedocs.org/

Usage

Here’s a quick usage example:

>>> from boardgamegeek import BoardGameGeek
>>> bgg = BoardGameGeek()
>>> g = bgg.game("Android: Netrunner")
>>> g.name
'Android: Netrunner'
>>> g.id
124742
>>> for n in g.alternative_names: print n.encode("utf-8")
...
安卓纪元:矩阵潜袭

To Do

  • Not all the information exposed by the official API is stored into the Python objects. Need to improve this.
  • Try to support the other sites from the boardgamegeek’s family
  • Allow better control for configuring the cache
  • Improve documentation :)

Contributions/suggestions are welcome.

 
File Type Py Version Uploaded on Size
boardgamegeek-0.0.7.tar.gz (md5, pgp) Source 2014-08-14 9KB
  • Downloads (All Versions):
  • 170 downloads in the last day
  • 657 downloads in the last week
  • 2014 downloads in the last month