bgg-api

Name	bgg-api JSON
Version	1.1.13 JSON
	download
home_page	https://github.com/SukiCZ/boardgamegeek
Summary	A Python API for boardgamegeek.com
upload_time	2025-09-08 20:53:43
maintainer	None
docs_url	None
author	Jakub Boukal
requires_python	>=3.8
license	BSD
keywords	boardgamegeek bgg boardgame api
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI
coveralls test coverage

            # 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

# access_token is recommended (soon to be required)
bgg = BGGClient(access_token="your_bgg_access_token")

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

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/SukiCZ/boardgamegeek",
    "name": "bgg-api",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "boardgamegeek, bgg, boardgame, api",
    "author": "Jakub Boukal",
    "author_email": "Jakub Boukal <www.bagr@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/2a/85/e32835c9c3ff5631b0f7be53bddf7f94d8c3b34a7cffae5d3735f222a128/bgg_api-1.1.13.tar.gz",
    "platform": null,
    "description": "# BGG-API\n\n### A Python API for [boardgamegeek.com](https://boardgamegeek.com/)\n\n\n[![docs status](https://readthedocs.org/projects/bgg-api/badge/?version=latest)](https://bgg-api.readthedocs.io/en/latest/)\n[![ci workflow status](https://github.com/SukiCZ/boardgamegeek/actions/workflows/ci.yml/badge.svg)](https://github.com/SukiCZ/boardgamegeek/actions)\n[![codecov](https://codecov.io/gh/SukiCZ/boardgamegeek/graph/badge.svg?token=LMOWZ62OIS)](https://codecov.io/gh/SukiCZ/boardgamegeek)\n[![Black code style](https://img.shields.io/badge/code_style-black-000000.svg)](https://github.com/ambv/black)\n![Contributions welcome](https://img.shields.io/badge/contributions-welcome-green.svg)\n\n## Installation\n\n```bash\npip install bgg-api\n```\n\n## Usage\n\nCreate an application and get the access token [here](https://boardgamegeek.com/applications).\n\n```python\nfrom boardgamegeek import BGGClient\n\n# access_token is recommended (soon to be required)\nbgg = BGGClient(access_token=\"your_bgg_access_token\")\n\ngame = bgg.game(\"Monopoly\")\n\nprint(game.year)  # 1935\nprint(game.rating_average)  # 4.36166\n```\n\n## Development\n\n```bash\n# Install dependencies\npip install -r requirements/develop.txt\n# Install pre-commit hooks\npre-commit install\n\n# Run tests\npytest .\n# Run tests with tox\ntox\n```\n\n## Publishing\n\n```bash\n# Bump version (patch, minor, major)\nbump2version patch\n# Push to github\ngit push --tags origin master\n```\n",
    "bugtrack_url": null,
    "license": "BSD",
    "summary": "A Python API for boardgamegeek.com",
    "version": "1.1.13",
    "project_urls": {
        "Coverage": "https://codecov.io/gh/SukiCZ/boardgamegeek",
        "Documentation": "https://bgg-api.readthedocs.io/en/latest/",
        "Homepage": "https://github.com/SukiCZ/boardgamegeek"
    },
    "split_keywords": [
        "boardgamegeek",
        " bgg",
        " boardgame",
        " api"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "ee32ceddd501f6d1c939e131184931a376132ab6199fd6d16f4ff061f1d8fefb",
                "md5": "27ff8553cdc4c54624c4ecfe336d4b4e",
                "sha256": "6babe32ddb0ccbba7292b789770bd64ef523cab0d2cfd0a2c326cebce3e842e7"
            },
            "downloads": -1,
            "filename": "bgg_api-1.1.13-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "27ff8553cdc4c54624c4ecfe336d4b4e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 42565,
            "upload_time": "2025-09-08T20:53:41",
            "upload_time_iso_8601": "2025-09-08T20:53:41.945027Z",
            "url": "https://files.pythonhosted.org/packages/ee/32/ceddd501f6d1c939e131184931a376132ab6199fd6d16f4ff061f1d8fefb/bgg_api-1.1.13-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "2a85e32835c9c3ff5631b0f7be53bddf7f94d8c3b34a7cffae5d3735f222a128",
                "md5": "1b4db80f7a89a2c8a00cf3f3365eae5e",
                "sha256": "1e921b1d2818157418abb90d4ae7a50d8b071f1ade4ab47add1c8fdfa333e6dc"
            },
            "downloads": -1,
            "filename": "bgg_api-1.1.13.tar.gz",
            "has_sig": false,
            "md5_digest": "1b4db80f7a89a2c8a00cf3f3365eae5e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 41625,
            "upload_time": "2025-09-08T20:53:43",
            "upload_time_iso_8601": "2025-09-08T20:53:43.410886Z",
            "url": "https://files.pythonhosted.org/packages/2a/85/e32835c9c3ff5631b0f7be53bddf7f94d8c3b34a7cffae5d3735f222a128/bgg_api-1.1.13.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-08 20:53:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "SukiCZ",
    "github_project": "boardgamegeek",
    "travis_ci": true,
    "coveralls": true,
    "github_actions": true,
    "tox": true,
    "lcname": "bgg-api"
}