meeple-cli 0.1.0b1

Local board game collection manager. Powered by BoardGameGeek.

meeple-cli

Local board game collection manager. Powered by BoardGameGeek.

meeple-cli allows you to create and manage local board game collections stored on your system. At this time the BoardGameGeek API does not allow for creation nor modification of GeekLists directly.

Install

Coming soon.

Usage

meeple

Roadmap

See a list of already implemented features/changes in the Changelog.

Features

• Search BoardGameGeek for a board game or expansion -> meeple search
• Get and display detailed info for a board game or expansion -> meeple info
• Open a board game or expansion on BoardGameGeek in browser -> meeple open
• Display current BoardGameGeek hotness list -> meeple hot
• Create a new local collection -> meeple new
• Add a board game/expansion to a local collection -> meeple add
• List all local collections -> meeple collections
• List all board games/expansions in a local collection -> meeple list
• Drop a board game/expansion from a local collection -> meeple drop
• Delete a local collection -> meeple delete
• Update local collection data with snapshot from BoardGameGeek -> meeple update
• Display average board game stats for a collection -> meeple stats
• Store local collection data in user's home directory -> at ~/.meeple/
• Find board games/expansions across local collections by attributes -> meeple find
• Rename a local collection -> meeple rename
• Copy a local collection -> meeple copy
• Move a board game/expansion from one local collection to another -> meeple move
• Export a local collection to csv or another format -> meeple export
• Import a local collection from a variety of formats -> meeple import
• Ability to sort listed outputs by a particular column
• Ability to display only a given number of rows
• Manage user preferences/configs -> meeple config stored at ~/.meeple/config.json or something
  • Toggle colorized output
  • Set custom default output sorts
  • Set custom data location
• Show elegant data diffs on meeple update (individual board game stat changes/collection stat changes)
• Output pagination for long lists?
• Identify when changes have been made to a collection and an update has not occurred yet

Long Shot Ideas (May or may not happen)

• Service or job that runs once a day to automatically update local data
  • Ability to output graphs/visuals to show change in collections over time
  • Ability to output graphs/visuals to show a board game's changes on BoardGameGeek over time
• Ability to assign and manage personal ratings to board games/expansions
• Ability to record and manage plays of board games - would be nuts.
  • Ability to calculate and surface play statistics for a board game
• Ability to interact with discord services to show that you are currently playing a board game?
• Ability to actually interact with BoardGameGeek user profile/settings/collections (not all currently possible via the API)
• Shell completions for common shells? For finding/searching.

Technical

• Convert to pyproject.toml build system (via flit)
• Linting (via trunk)
• Unit tests
• CI/CD pipeline (via travis)
• Documentation site (via vitepress?)
• Pre-releases published to test pypi
• Publish v1.0.0 to pypi
• Homebrew formula (will be available here)
• Implement simple logging for debugging (local, not telemetry) (via loguru?)

License

Copyright (c) 2022 Bradley Wojcik. Released under the MIT License. See LICENSE for details.