Skip to main content

A Python API for boardgamegeek.com

Project description

BGG-API

A Python API for boardgamegeek.com

docs status ci workflow status codecov Black code style Contributions welcome

Installation

pip install bgg-api

Usage

from boardgamegeek import BGGClient

bgg = BGGClient()

game = bgg.game("Monopoly")

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

Development

# Install dependencies
pip install -r requirements/develop.txt
# Install pre-commit hooks
pre-commit install

# Format XML files
cd test/xml
find . -exec sh -c 'xmllint --format "$1" > "$1.tmp" && mv "$1.tmp" "$1"' _ {} \;


# Run tests
pytest .
# Run tests with tox
tox

Publishing

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

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

bgg-api-1.1.6.tar.gz (37.6 kB view hashes)

Uploaded Source

Built Distribution

bgg_api-1.1.6-py2.py3-none-any.whl (38.8 kB view hashes)

Uploaded Python 2 Python 3

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