Skip to main content

A Python interface to boardgamegeek.com's API

Project description

https://travis-ci.org/lcosmin/boardgamegeek.svg?branch=master https://coveralls.io/repos/lcosmin/boardgamegeek/badge.png?branch=master

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.

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")
...
安卓纪元:矩阵潜袭

If you want to use the disk cache:

>>> bgg = BoardGameGeek(cache="sqlite:///tmp/cache.db?ttl=3600&fast_save=0")
>>> g = bgg.game("Celtica")
>>> g.id
21293

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

  • Improve documentation :)

  • Improve unit testing

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.3.0.tar.gz (19.5 kB view details)

Uploaded Source

File details

Details for the file boardgamegeek-0.3.0.tar.gz.

File metadata

File hashes

Hashes for boardgamegeek-0.3.0.tar.gz
Algorithm Hash digest
SHA256 bd9e7d52e89923c6e313702a0bfba9d4184427aeec6671c2468338c2beb0e7f1
MD5 1a7c51b3d51af6d3f86981269b748346
BLAKE2b-256 185a5d83fe25fd4dbd80525655dc12fc1423e0671ec70bc1de11cf2c2b830343

See more details on using hashes here.

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