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

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

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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

bgg_api-1.1.17-py3-none-any.whl (45.1 kB view details)

Uploaded Python 3

File details

Details for the file bgg_api-1.1.17.tar.gz.

File metadata

  • Download URL: bgg_api-1.1.17.tar.gz
  • Upload date:
  • Size: 43.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for bgg_api-1.1.17.tar.gz
Algorithm Hash digest
SHA256 bb29f904d16d18d919b9840f257cd462cf690a9c7f625f7d23769789d3a544d2
MD5 9f796c0b70fb5977966b3c8c2450607f
BLAKE2b-256 2fb2b3b20baeeac024798504d792ea07c37b748828675ad33a2113365990e467

See more details on using hashes here.

Provenance

The following attestation bundles were made for bgg_api-1.1.17.tar.gz:

Publisher: ci.yml on SukiCZ/boardgamegeek

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bgg_api-1.1.17-py3-none-any.whl.

File metadata

  • Download URL: bgg_api-1.1.17-py3-none-any.whl
  • Upload date:
  • Size: 45.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for bgg_api-1.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 363f0b330d7c640d9b0169d14a934abe96aba38c867354ab855f1bd1288fd66f
MD5 b76e45d33053237212926f51071aac90
BLAKE2b-256 48f426cb734ddd55586244cc2799d045bd093502d9103b1c54553643cd457511

See more details on using hashes here.

Provenance

The following attestation bundles were made for bgg_api-1.1.17-py3-none-any.whl:

Publisher: ci.yml on SukiCZ/boardgamegeek

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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