Skip to content

Latest commit

 

History

History
52 lines (37 loc) · 1.2 KB

README.md

File metadata and controls

52 lines (37 loc) · 1.2 KB

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

# Run tests
pytest .
# Run tests with tox
tox

Publishing

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