Skip to main content

Board game recommendation engine

Project description

Board Game Recommender

PyPI PyPI - Python Version PyPI - License Coookiecutter - Wolt


Documentation: https://recommend-games.github.io/board-game-recommender

Source Code: https://github.com/recommend-games/board-game-recommender

PyPI: https://pypi.org/project/board-game-recommender/


Board game recommendation engine.

Installation

pip install board-game-recommender

Development

  • Clone this repository
  • Requirements:
  • Create a virtual environment and install the dependencies
poetry install
  • Activate the virtual environment
poetry shell

Testing

pytest

Documentation

The documentation is automatically generated from the content of the docs directory and from the docstrings of the public signatures of the source code. The documentation is updated and published as a Github Pages page automatically as part each release.

Releasing

Trigger the Draft release workflow (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 and publish it. When a release is published, it'll trigger release 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):

pre-commit install

Or if you want them to run only for each push:

pre-commit install -t pre-push

Or if you want e.g. want to run all checks manually for all files:

pre-commit run --all-files

This project was generated using the wolt-python-package-cookiecutter template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

board_game_recommender-4.0.0.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

board_game_recommender-4.0.0-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file board_game_recommender-4.0.0.tar.gz.

File metadata

  • Download URL: board_game_recommender-4.0.0.tar.gz
  • Upload date:
  • Size: 9.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.5 CPython/3.12.10 Darwin/24.4.0

File hashes

Hashes for board_game_recommender-4.0.0.tar.gz
Algorithm Hash digest
SHA256 74cd63851507445b124db8ba815dafb039c1df76ee870dfb090668c8c3acdb34
MD5 fa13f539ccf8f45afed7e640ab0170d5
BLAKE2b-256 c6b7f38511a4a90bf52d7e04f3d548495e19f80e3b7cc34ee666206afbe8a4ad

See more details on using hashes here.

File details

Details for the file board_game_recommender-4.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for board_game_recommender-4.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7a25402ebe89e14605ddef22b0bf445b8f0441b74c15920b4c64102ce23b5fe9
MD5 27ee655bca6eb8e4d63180eadf20ed81
BLAKE2b-256 4cb0ecaaf240d5650da751b5ffa95b17106d13abad3a28f10bf8b463027b4804

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page