boardgamegeek - A Python API for boardgamegeek.com

Note

The documentation is a work in progress. You can check out the unit tests for examples on how to use the library.

Introduction

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

It’s an almost completely rewritten fork of libBGG.

Table of Contents

• Changelog
  • 1.0.0
  • 0.13.2
  • 0.13.1
  • 0.13.0
  • 0.12.1
  • 0.12.0
  • 0.11.2
  • 0.11.1
  • 0.11.0
  • 0.10.1
  • 0.10.0
  • 0.9.0
  • 0.8.1
  • 0.8.0
  • 0.7.1
  • 0.7.0
  • 0.6.0
  • 0.5.0
  • 0.4.3
  • 0.4.2
  • 0.4.0
  • 0.3.0
  • 0.2.0 (unreleased)
  • 0.1.0
  • 0.0.14
  • 0.0.13
  • 0.0.12
  • 0.0.11
  • 0.0.10
  • 0.0.9
• Modules
  • boardgamegeek.api - Core functions
  • boardgamegeek.collection - Collection information
  • boardgamegeek.exceptions - Exceptions
  • boardgamegeek.games - Games information
  • boardgamegeek.guild - Guild information
  • boardgamegeek.hotitems - BoardGameGeek “Hot Items”
  • boardgamegeek.plays - BoardGameGeek “Plays”
  • boardgamegeek.search - Search results
  • boardgamegeek.things - Generic objects
  • boardgamegeek.user - BoardGameGeek “Users”
  • boardgamegeek.utils - Generic helper functions

Features

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

• Users
• Games
• User collections
• Player guilds
• Plays
• Hot items

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

Note

The cache is enabled by default and it’s configured to use memory only. It’s also possible to use SQLite for a persistent cache.

Quick Install

To install boardgamegeek, just use pip:

> pip install boardgamegeek2

If you had previously used this library before it was rewritten, you’ll need to uninstall it first:

> pip uninstall boardgamegeek

Usage

Here’s a quick usage example:

>>> from boardgamegeek import BGGClient
>>> bgg = BGGClient()
>>> 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!

Credits

Original authors:

• Phil S. Stein (github:philsstein)
• Geoff Lawler (github:glawler)

Contributions to this fork:

• Tom Usher (github:tomusher)
• Brent Ropp (github:bar350)
• Michał Machnicki (github:machnic)
• Philip Kendall (github:pak21)
• David Feng (github:selwyth)
• Emil Stenström (github:EmilStenstrom)

Indices and tables

• Index
• Module Index
• Search Page