Skip to content

SukiCZ/boardgamegeek

 
 

Repository files navigation

BGG-API

A Python API for boardgamegeek.com

docs status ci workflow status codecov Black code style Contributions welcome

Installation

uv add bgg-api

Or with pip:

pip install bgg-api

Usage

Create an application and get the access token here.

from boardgamegeek import BGGClient

bgg = BGGClient("<access_token_here>")

game = bgg.game("Monopoly")

print(game.year)  # 1935
print(game.rating_average)  # 4.36166

Development

# Install dependencies
uv sync --extra dev
# Install pre-commit hooks
uv run prek install

# Run tests
uv run pytest .
# Run tests with tox
uv run tox

Publishing

# Bump version (patch, minor, major)
bump2version patch
# Push to github
git push --tags origin master

About

A Python interface to boardgamegeek.com. Pulls information from BGG and creates Python objects for the data.

Topics

Resources

License

Stars

33 stars

Watchers

7 watching

Forks

Packages

 
 
 

Contributors

Languages

  • Python 100.0%