semvec/pypi-packages huggingface dataset:
bgg-api 1.1.16
A Python API for boardgamegeek.com
License: BSD
Requires Python: >=3.8
Keywords: boardgamegeek, bgg, boardgame, api

# BGG-API

### A Python API for [boardgamegeek.com](https://boardgamegeek.com/)


[![docs status](https://readthedocs.org/projects/bgg-api/badge/?version=latest)](https://bgg-api.readthedocs.io/en/latest/)
[![ci workflow status](https://github.com/SukiCZ/boardgamegeek/actions/workflows/ci.yml/badge.svg)](https://github.com/SukiCZ/boardgamegeek/actions)
[![codecov](https://codecov.io/gh/SukiCZ/boardgamegeek/graph/badge.svg?token=LMOWZ62OIS)](https://codecov.io/gh/SukiCZ/boardgamegeek)
[![Black code style](https://img.shields.io/badge/code_style-black-000000.svg)](https://github.com/ambv/black)
![Contributions welcome](https://img.shields.io/badge/contributions-welcome-green.svg)

## Installation

```bash
pip install bgg-api
```

## Usage

Create an application and get the access token [here](https://boardgamegeek.com/applications).

```python
from boardgamegeek import BGGClient

bgg = BGGClient("<access_token_here>")

game = bgg.game("Monopoly")

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

## Development

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

# Run tests
pytest .
# Run tests with tox
tox
```

## Publishing

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