Metadata-Version: 2.4
Name: bgg-api
Version: 1.1.17
Summary: A Python API for boardgamegeek.com
Home-page: https://github.com/SukiCZ/boardgamegeek
Author: Jakub Boukal
Author-email: Jakub Boukal <www.bagr@gmail.com>
License: BSD
Project-URL: Homepage, https://github.com/SukiCZ/boardgamegeek
Project-URL: Documentation, https://bgg-api.readthedocs.io/en/latest/
Project-URL: Coverage, https://codecov.io/gh/SukiCZ/boardgamegeek
Keywords: boardgamegeek,bgg,boardgame,api
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: License :: OSI Approved :: BSD License
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: Games/Entertainment :: Board Games
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS.md
Requires-Dist: requests<3.0.0,>=2.31.0
Requires-Dist: requests-cache<2.0.0,>=1.1.1
Provides-Extra: dev
Requires-Dist: bump-my-version; extra == "dev"
Requires-Dist: wheel; extra == "dev"
Requires-Dist: tox; extra == "dev"
Requires-Dist: Sphinx; extra == "dev"
Requires-Dist: myst-parser; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-mock; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: prek; extra == "dev"
Requires-Dist: types-requests; extra == "dev"
Dynamic: author
Dynamic: home-page
Dynamic: license-file

# 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
uv add bgg-api
```

Or with pip:

```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
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

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