Metadata-Version: 2.4
Name: yamu
Version: 0.3.0
Summary: game library manager
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Requires-Dist: PyYAML>=6.0
Requires-Dist: Jinja2>=3.1
Requires-Dist: howlongtobeatpy>=1.0.21
Provides-Extra: dev
Requires-Dist: pytest>=7.4; extra == "dev"
Requires-Dist: ruff>=0.6.0; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx>=7.2; extra == "docs"
Requires-Dist: pydata-sphinx-theme>=0.15; extra == "docs"
Requires-Dist: sphinx-copybutton>=0.5; extra == "docs"
Requires-Dist: sphinx-design>=0.5; extra == "docs"

# yamu

> A game library manager for geeks.

Yamu provides a simple way to manage game collections across multiple platforms (Steam, GOG, itch.io, etc).
It is extensible, supporting new platforms and features via plugins, and is composable with other UNIX tools and cli utilities.

## Installation

Run `pipx install yamu` to install via pipx.

## Quick start

Run `yamu --help` to see commands.

```
yamu import                           # Import games from configured platforms
yamu list platform:steam genre:action # List all Steam games in the action genre
yamu completion                       # Mark games as completed, interaactively
yamu fetchart                         # Fetch cover art games
yamu web                              # Open the web interface to view your library
```

For `yamu import`, configure plugins in `~/.config/yamu/config.yaml`:

```yaml
library: "~/.local/share/yamu/library.db"
plugins:
  - web 
  - steam
  - fetchart
  - igdb
  - howlongtobeat

steam:
  api_key: "your_key"
  steam_ids:
    - "steam64_id"

igdb:
  client_id: "your_client_id"
  client_secret: "your_client_secret"

howlongtobeat:
  minimum_similarity: 0.4
  similarity_case_sensitive: false
  auto_filter_times: false
```

## Development

Create a virtual environment, install dev dependencies, and run tests:

```
python3 -m venv .venv
source .venv/bin/activate
python -m pip install -e ".[dev]"
python -m pytest
```

## Acknowledgements

- [The beets project for inspiring yamu's design.](https://beets.io/)
- [Icon by Ehtisham Abid](https://www.flaticon.com/free-icon/yam_5687397)
