Skip to main content

A Python interface to boardgamegeek.com's API

Project description

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.

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.

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.

Project details


Download files

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

Source Distribution

boardgamegeek-0.0.9.tar.gz (12.4 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page