# Spiel des Jahres
[](https://pypi.python.org/pypi/spiel-des-jahres/)
[](https://pypi.python.org/pypi/spiel-des-jahres/)
[](https://pypi.python.org/pypi/spiel-des-jahres/)
[](https://github.com/woltapp/wolt-python-package-cookiecutter)
---
**Documentation**: [https://recommend-games.github.io/spiel-des-jahres](https://recommend-games.github.io/spiel-des-jahres)
**Source Code**: [https://github.com/recommend-games/spiel-des-jahres](https://github.com/recommend-games/spiel-des-jahres)
**PyPI**: [https://pypi.org/project/spiel-des-jahres/](https://pypi.org/project/spiel-des-jahres/)
---
Spiel des Jahres predictions
## Installation
```sh
pip install spiel-des-jahres
```
## Development
* Clone this repository
* Requirements:
* [Poetry](https://python-poetry.org/)
* Python 3.8+
* 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/recommend-games/spiel-des-jahres/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/recommend-games/spiel-des-jahres/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/recommend-games/spiel-des-jahres/releases) and publish it. When
a release is published, it'll trigger [release](https://github.com/recommend-games/spiel-des-jahres/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://recommend-games.github.io/spiel-des-jahres",
"name": "spiel-des-jahres",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10.0",
"maintainer_email": null,
"keywords": null,
"author": "Markus Shepherd",
"author_email": "markus@recommend.games",
"download_url": "https://files.pythonhosted.org/packages/85/f3/82d3318e9a9806b1ffea42259edb5485bee0158eaa8ac26f546ef14cdc4b/spiel_des_jahres-0.0.2.tar.gz",
"platform": null,
"description": "# Spiel des Jahres\n\n[](https://pypi.python.org/pypi/spiel-des-jahres/)\n[](https://pypi.python.org/pypi/spiel-des-jahres/)\n[](https://pypi.python.org/pypi/spiel-des-jahres/)\n[](https://github.com/woltapp/wolt-python-package-cookiecutter)\n\n\n---\n\n**Documentation**: [https://recommend-games.github.io/spiel-des-jahres](https://recommend-games.github.io/spiel-des-jahres)\n\n**Source Code**: [https://github.com/recommend-games/spiel-des-jahres](https://github.com/recommend-games/spiel-des-jahres)\n\n**PyPI**: [https://pypi.org/project/spiel-des-jahres/](https://pypi.org/project/spiel-des-jahres/)\n\n---\n\nSpiel des Jahres predictions\n\n## Installation\n\n```sh\npip install spiel-des-jahres\n```\n\n## Development\n\n* Clone this repository\n* Requirements:\n * [Poetry](https://python-poetry.org/)\n * Python 3.8+\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/recommend-games/spiel-des-jahres/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/recommend-games/spiel-des-jahres/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/recommend-games/spiel-des-jahres/releases) and publish it. When\n a release is published, it'll trigger [release](https://github.com/recommend-games/spiel-des-jahres/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": "Spiel des Jahres predictions",
"version": "0.0.2",
"project_urls": {
"Documentation": "https://recommend-games.github.io/spiel-des-jahres",
"Homepage": "https://recommend-games.github.io/spiel-des-jahres",
"Repository": "https://github.com/recommend-games/spiel-des-jahres"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a44cf605ef9d23e7a971dd970b3f8a23e4a3ba699b29a2cd0c811af846e846de",
"md5": "cdcaea5b5b5f3b109d030f0c93cf093b",
"sha256": "4c6a924a9c7ee7e2872cd336651abdba02afc53705fbe4f70fc5a712ec15c6f1"
},
"downloads": -1,
"filename": "spiel_des_jahres-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cdcaea5b5b5f3b109d030f0c93cf093b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10.0",
"size": 4582,
"upload_time": "2024-06-08T21:00:09",
"upload_time_iso_8601": "2024-06-08T21:00:09.206844Z",
"url": "https://files.pythonhosted.org/packages/a4/4c/f605ef9d23e7a971dd970b3f8a23e4a3ba699b29a2cd0c811af846e846de/spiel_des_jahres-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "85f382d3318e9a9806b1ffea42259edb5485bee0158eaa8ac26f546ef14cdc4b",
"md5": "84eb97ce177d51bc0e5f9774414fadde",
"sha256": "0cfa4326bdd030561fba116be59ff8b7575d0df1fb905b8f60b462dfb07c01a9"
},
"downloads": -1,
"filename": "spiel_des_jahres-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "84eb97ce177d51bc0e5f9774414fadde",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10.0",
"size": 4777,
"upload_time": "2024-06-08T21:00:10",
"upload_time_iso_8601": "2024-06-08T21:00:10.549821Z",
"url": "https://files.pythonhosted.org/packages/85/f3/82d3318e9a9806b1ffea42259edb5485bee0158eaa8ac26f546ef14cdc4b/spiel_des_jahres-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-08 21:00:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "recommend-games",
"github_project": "spiel-des-jahres",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "spiel-des-jahres"
}
JSON
