# board-game-merger
[](https://pypi.python.org/pypi/board-game-merger/)
[](https://pypi.python.org/pypi/board-game-merger/)
[](https://pypi.python.org/pypi/board-game-merger/)
[](https://github.com/woltapp/wolt-python-package-cookiecutter)
---
**Documentation**: [https://MarkusShepherd.github.io/board-game-merger](https://MarkusShepherd.github.io/board-game-merger)
**Source Code**: [https://github.com/MarkusShepherd/board-game-merger](https://github.com/MarkusShepherd/board-game-merger)
**PyPI**: [https://pypi.org/project/board-game-merger/](https://pypi.org/project/board-game-merger/)
---
Merging board game data
## Installation
```sh
pip install board-game-merger
```
## Development
* Clone this repository
* Requirements:
* [Poetry](https://python-poetry.org/)
* Python 3.9+
* Create a virtual environment and install the dependencies
```sh
poetry install
```
* Activate the virtual environment
```sh
poetry shell
```
### Testing
```sh
pytest
```
### Documentation
The documentation is automatically generated from the content of the [docs directory](https://github.com/MarkusShepherd/board-game-merger/tree/master/docs) and from the docstrings
of the public signatures of the source code. The documentation is updated and published as a [Github Pages page](https://pages.github.com/) automatically as part each release.
### Releasing
Trigger the [Draft release workflow](https://github.com/MarkusShepherd/board-game-merger/actions/workflows/draft_release.yml)
(press _Run workflow_). This will update the changelog & version and create a GitHub release which is in _Draft_ state.
Find the draft release from the
[GitHub releases](https://github.com/MarkusShepherd/board-game-merger/releases) and publish it. When
a release is published, it'll trigger [release](https://github.com/MarkusShepherd/board-game-merger/blob/master/.github/workflows/release.yml) workflow which creates PyPI
release and deploys updated documentation.
### Pre-commit
Pre-commit hooks run all the auto-formatting (`ruff format`), linters (e.g. `ruff` and `mypy`), and other quality
checks to make sure the changeset is in good shape before a commit/push happens.
You can install the hooks with (runs for each commit):
```sh
pre-commit install
```
Or if you want them to run only for each push:
```sh
pre-commit install -t pre-push
```
Or if you want e.g. want to run all checks manually for all files:
```sh
pre-commit run --all-files
```
---
This project was generated using the [wolt-python-package-cookiecutter](https://github.com/woltapp/wolt-python-package-cookiecutter) template.
Raw data
{
"_id": null,
"home_page": "https://MarkusShepherd.github.io/board-game-merger",
"name": "board-game-merger",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9.0",
"maintainer_email": null,
"keywords": null,
"author": "Markus Shepherd",
"author_email": "markus@recommend.games",
"download_url": "https://files.pythonhosted.org/packages/e1/06/787ae386edcfbf43557c81cbb07f8b8c9b18a95e695632e78f1cc46b48dc/board_game_merger-1.0.0.tar.gz",
"platform": null,
"description": "# board-game-merger\n\n[](https://pypi.python.org/pypi/board-game-merger/)\n[](https://pypi.python.org/pypi/board-game-merger/)\n[](https://pypi.python.org/pypi/board-game-merger/)\n[](https://github.com/woltapp/wolt-python-package-cookiecutter)\n\n\n---\n\n**Documentation**: [https://MarkusShepherd.github.io/board-game-merger](https://MarkusShepherd.github.io/board-game-merger)\n\n**Source Code**: [https://github.com/MarkusShepherd/board-game-merger](https://github.com/MarkusShepherd/board-game-merger)\n\n**PyPI**: [https://pypi.org/project/board-game-merger/](https://pypi.org/project/board-game-merger/)\n\n---\n\nMerging board game data\n\n## Installation\n\n```sh\npip install board-game-merger\n```\n\n## Development\n\n* Clone this repository\n* Requirements:\n * [Poetry](https://python-poetry.org/)\n * Python 3.9+\n* Create a virtual environment and install the dependencies\n\n```sh\npoetry install\n```\n\n* Activate the virtual environment\n\n```sh\npoetry shell\n```\n\n### Testing\n\n```sh\npytest\n```\n\n### Documentation\n\nThe documentation is automatically generated from the content of the [docs directory](https://github.com/MarkusShepherd/board-game-merger/tree/master/docs) and from the docstrings\n of the public signatures of the source code. The documentation is updated and published as a [Github Pages page](https://pages.github.com/) automatically as part each release.\n\n### Releasing\n\nTrigger the [Draft release workflow](https://github.com/MarkusShepherd/board-game-merger/actions/workflows/draft_release.yml)\n(press _Run workflow_). This will update the changelog & version and create a GitHub release which is in _Draft_ state.\n\nFind the draft release from the\n[GitHub releases](https://github.com/MarkusShepherd/board-game-merger/releases) and publish it. When\n a release is published, it'll trigger [release](https://github.com/MarkusShepherd/board-game-merger/blob/master/.github/workflows/release.yml) workflow which creates PyPI\n release and deploys updated documentation.\n\n### Pre-commit\n\nPre-commit hooks run all the auto-formatting (`ruff format`), linters (e.g. `ruff` and `mypy`), and other quality\n checks to make sure the changeset is in good shape before a commit/push happens.\n\nYou can install the hooks with (runs for each commit):\n\n```sh\npre-commit install\n```\n\nOr if you want them to run only for each push:\n\n```sh\npre-commit install -t pre-push\n```\n\nOr if you want e.g. want to run all checks manually for all files:\n\n```sh\npre-commit run --all-files\n```\n\n---\n\nThis project was generated using the [wolt-python-package-cookiecutter](https://github.com/woltapp/wolt-python-package-cookiecutter) template.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Merging board game data",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://MarkusShepherd.github.io/board-game-merger",
"Homepage": "https://MarkusShepherd.github.io/board-game-merger",
"Repository": "https://github.com/MarkusShepherd/board-game-merger"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2d75c5b3d3ca1b8245ed320910653dcc7367c72525e4a42e77df8dc028f575ed",
"md5": "4350237435ff8ddd6d1c846204d26448",
"sha256": "4960d1775b626f86e6715a720626118c892266dcb0e08af505d9eebd63dcbfa3"
},
"downloads": -1,
"filename": "board_game_merger-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4350237435ff8ddd6d1c846204d26448",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9.0",
"size": 8899,
"upload_time": "2024-11-10T20:42:22",
"upload_time_iso_8601": "2024-11-10T20:42:22.879510Z",
"url": "https://files.pythonhosted.org/packages/2d/75/c5b3d3ca1b8245ed320910653dcc7367c72525e4a42e77df8dc028f575ed/board_game_merger-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e106787ae386edcfbf43557c81cbb07f8b8c9b18a95e695632e78f1cc46b48dc",
"md5": "57cf3161d4b6cfe20ddab16f435cba4d",
"sha256": "87663cfc9403e5de1823ecd746b7b1eb2b020152f0051d5b837c99a070e63452"
},
"downloads": -1,
"filename": "board_game_merger-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "57cf3161d4b6cfe20ddab16f435cba4d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9.0",
"size": 9323,
"upload_time": "2024-11-10T20:42:23",
"upload_time_iso_8601": "2024-11-10T20:42:23.732726Z",
"url": "https://files.pythonhosted.org/packages/e1/06/787ae386edcfbf43557c81cbb07f8b8c9b18a95e695632e78f1cc46b48dc/board_game_merger-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-10 20:42:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MarkusShepherd",
"github_project": "board-game-merger",
"github_not_found": true,
"lcname": "board-game-merger"
}
JSON
