simkl-mps


Namesimkl-mps JSON
Version 2.2.0 PyPI version JSON
download
home_pagehttps://github.com/ByteTrix/Media-Player-Scrobbler-for-Simkl
SummaryAutomatic Media Scrobbler for Simkl
upload_time2025-08-15 11:08:18
maintainerNone
docs_urlNone
authorkavinthangavel
requires_python<3.14,>=3.9
licenseGPL-3.0
keywords simkl scrobbler
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 🎬 Media Player Scrobbler for Simkl

[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-blue.svg)]()
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/ByteTrix/Media-Player-Scrobbler-for-Simkl)
<div align="center">
  <img src="simkl_mps/assets/simkl-mps.png" alt="SIMKL MPS Logo" width="120"/>
  <br/>
  <em>Automatic media tracking for all your media players</em>
</div>

## ✨ Features

- 🎮 **Supports Every Famous Media Player** (VLC, MPV, MPC-HC and more)
- 🌐 **Cross-Platform** – Windows, macOS, Linux
- 🖥️ **Native Executable** – System tray, auto-update, and background service (Windows)
- 📈 **Accurate Position Tracking** – For supported players (configure via [Media Players Guide](docs/media-players.md))
- 🔌 **Offline Support** – Queues updates when offline
- 🧠 **Smart Media Detection** – Intelligent filename parsing
- 🍿 **Media-Focused** – Optimized for every type of media (Movies,TV Shows and Anime)

## ⚡ Quick Start

- **Windows:** Use the [Windows Guide](docs/windows-guide.md) (EXE installer, tray app, no commands needed).
- **Linux:** Use the [Linux Guide](docs/linux-guide.md) (pipx recommended, tray app, setup command needed).
- **macOS:** Use the [Mac Guide](docs/mac-guide.md) (pip install, tray app, setup command needed, untested).

After installation, authenticate with SIMKL and **configure your media players** using the [Media Players Guide](docs/media-players.md) (this step is critical for accurate tracking).

## 📚 Documentation

- [Windows Guide](docs/windows-guide.md)
- [Linux Guide](docs/linux-guide.md)
- [Mac Guide](docs/mac-guide.md)
- [Supported Media Players](docs/media-players.md)
- [Usage Guide](docs/usage.md)
- [Local Watch History](docs/watch-history.md)
- [Advanced & Developer Guide](docs/configuration.md)
- [Troubleshooting Guide](docs/troubleshooting.md)
- [Todo List](docs/todo.md)

## 🔍 How It Works

```mermaid
graph LR
    A[Media Player] -->|Player Title| B[Simkl Scrobbler]
    B -->|Parse Title| C[Media Identification]
    C -->|Track Progress| D[Simkl API]
    D -->|Mark as Watched| E[Simkl Profile]
    
    style A fill:#d5f5e3,stroke:#333,stroke-width:2px
    style E fill:#d5f5e3,stroke:#333,stroke-width:2px
```

## 🚦 Performance Notes

**Online:**
- Player Detection: ~4.2 sec
- Media Info Scrobble: ~3.7 sec
- Notification: ~1.5 sec
- Completion Detection Delay: ~5.2 sec
- Completion Sync: ~13.3 sec
- Completion Notification: ~1.5 sec

**Offline:**
- Media Scrobble: ~1.2 sec
- Notification: ~0.5 sec
- Completion Save: ~3 sec
- Completion Notification: ~0.5 sec

## 📝 License

See the [LICENSE](LICENSE) file for details.

## 🤝 Contributing

Contributions are welcome! Please submit a Pull Request.

## ☕ Support & Donate

If you find this project useful, consider supporting development:
[Donate via CoinDrop](https://coindrop.to/kavinthangavel)

## 🙏 Acknowledgments

- [Simkl](https://simkl.com) – API platform
- [guessit](https://github.com/guessit-io/guessit) – Filename parsing
- [iamkroot's Trakt Scrobbler](https://github.com/iamkroot/trakt-scrobbler/) – Inspiration
- [masyk](https://github.com/masyk) – Logo and technical guidance (SIMKL Dev)

## 🛠️ Related Tools

These tools can help organize and rename media files automatically, which can improve the accuracy and ease of scrobbling.

- [FileBot](https://www.filebot.net/) - Media File Renaming
- TVRename - TV File Data Automation (Optional)
- Shoko - Anime File Data Automation (Optional)
---

<div align="center">
  <p>Made with ❤️ by <a href="https://github.com/kavinthangavel">kavin</a></p>
  <p>
    <a href="https://github.com/ByteTrix/Media-Player-Scrobbler-for-Simkl/stargazers">⭐ Star us on GitHub</a> •
    <a href="https://github.com/ByteTrix/Media-Player-Scrobbler-for-Simkl/issues">🐞 Report Bug</a> •
    <a href="https://github.com/ByteTrix/Media-Player-Scrobbler-for-Simkl/issues">✨ Request Feature</a>
  </p>
</div>


            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ByteTrix/Media-Player-Scrobbler-for-Simkl",
    "name": "simkl-mps",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<3.14,>=3.9",
    "maintainer_email": null,
    "keywords": "simkl, scrobbler",
    "author": "kavinthangavel",
    "author_email": "kavinthangavel.dev@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/93/c3/87424ca90526608014d2f76fb00eadf7df83b4a4c78653622bf69ad02aa0/simkl_mps-2.2.0.tar.gz",
    "platform": null,
    "description": "# \ud83c\udfac Media Player Scrobbler for Simkl\n\n[![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-blue.svg)]()\n[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/ByteTrix/Media-Player-Scrobbler-for-Simkl)\n<div align=\"center\">\n  <img src=\"simkl_mps/assets/simkl-mps.png\" alt=\"SIMKL MPS Logo\" width=\"120\"/>\n  <br/>\n  <em>Automatic media tracking for all your media players</em>\n</div>\n\n## \u2728 Features\n\n- \ud83c\udfae **Supports Every Famous Media Player** (VLC, MPV, MPC-HC and more)\n- \ud83c\udf10 **Cross-Platform** \u2013 Windows, macOS, Linux\n- \ud83d\udda5\ufe0f **Native Executable** \u2013 System tray, auto-update, and background service (Windows)\n- \ud83d\udcc8 **Accurate Position Tracking** \u2013 For supported players (configure via [Media Players Guide](docs/media-players.md))\n- \ud83d\udd0c **Offline Support** \u2013 Queues updates when offline\n- \ud83e\udde0 **Smart Media Detection** \u2013 Intelligent filename parsing\n- \ud83c\udf7f **Media-Focused** \u2013 Optimized for every type of media (Movies,TV Shows and Anime)\n\n## \u26a1 Quick Start\n\n- **Windows:** Use the [Windows Guide](docs/windows-guide.md) (EXE installer, tray app, no commands needed).\n- **Linux:** Use the [Linux Guide](docs/linux-guide.md) (pipx recommended, tray app, setup command needed).\n- **macOS:** Use the [Mac Guide](docs/mac-guide.md) (pip install, tray app, setup command needed, untested).\n\nAfter installation, authenticate with SIMKL and **configure your media players** using the [Media Players Guide](docs/media-players.md) (this step is critical for accurate tracking).\n\n## \ud83d\udcda Documentation\n\n- [Windows Guide](docs/windows-guide.md)\n- [Linux Guide](docs/linux-guide.md)\n- [Mac Guide](docs/mac-guide.md)\n- [Supported Media Players](docs/media-players.md)\n- [Usage Guide](docs/usage.md)\n- [Local Watch History](docs/watch-history.md)\n- [Advanced & Developer Guide](docs/configuration.md)\n- [Troubleshooting Guide](docs/troubleshooting.md)\n- [Todo List](docs/todo.md)\n\n## \ud83d\udd0d How It Works\n\n```mermaid\ngraph LR\n    A[Media Player] -->|Player Title| B[Simkl Scrobbler]\n    B -->|Parse Title| C[Media Identification]\n    C -->|Track Progress| D[Simkl API]\n    D -->|Mark as Watched| E[Simkl Profile]\n    \n    style A fill:#d5f5e3,stroke:#333,stroke-width:2px\n    style E fill:#d5f5e3,stroke:#333,stroke-width:2px\n```\n\n## \ud83d\udea6 Performance Notes\n\n**Online:**\n- Player Detection: ~4.2 sec\n- Media Info Scrobble: ~3.7 sec\n- Notification: ~1.5 sec\n- Completion Detection Delay: ~5.2 sec\n- Completion Sync: ~13.3 sec\n- Completion Notification: ~1.5 sec\n\n**Offline:**\n- Media Scrobble: ~1.2 sec\n- Notification: ~0.5 sec\n- Completion Save: ~3 sec\n- Completion Notification: ~0.5 sec\n\n## \ud83d\udcdd License\n\nSee the [LICENSE](LICENSE) file for details.\n\n## \ud83e\udd1d Contributing\n\nContributions are welcome! Please submit a Pull Request.\n\n## \u2615 Support & Donate\n\nIf you find this project useful, consider supporting development:\n[Donate via CoinDrop](https://coindrop.to/kavinthangavel)\n\n## \ud83d\ude4f Acknowledgments\n\n- [Simkl](https://simkl.com) \u2013 API platform\n- [guessit](https://github.com/guessit-io/guessit) \u2013 Filename parsing\n- [iamkroot's Trakt Scrobbler](https://github.com/iamkroot/trakt-scrobbler/) \u2013 Inspiration\n- [masyk](https://github.com/masyk) \u2013 Logo and technical guidance (SIMKL Dev)\n\n## \ud83d\udee0\ufe0f Related Tools\n\nThese tools can help organize and rename media files automatically, which can improve the accuracy and ease of scrobbling.\n\n- [FileBot](https://www.filebot.net/) - Media File Renaming\n- TVRename - TV File Data Automation (Optional)\n- Shoko - Anime File Data Automation (Optional)\n---\n\n<div align=\"center\">\n  <p>Made with \u2764\ufe0f by <a href=\"https://github.com/kavinthangavel\">kavin</a></p>\n  <p>\n    <a href=\"https://github.com/ByteTrix/Media-Player-Scrobbler-for-Simkl/stargazers\">\u2b50 Star us on GitHub</a> \u2022\n    <a href=\"https://github.com/ByteTrix/Media-Player-Scrobbler-for-Simkl/issues\">\ud83d\udc1e Report Bug</a> \u2022\n    <a href=\"https://github.com/ByteTrix/Media-Player-Scrobbler-for-Simkl/issues\">\u2728 Request Feature</a>\n  </p>\n</div>\n\n",
    "bugtrack_url": null,
    "license": "GPL-3.0",
    "summary": "Automatic Media Scrobbler for Simkl",
    "version": "2.2.0",
    "project_urls": {
        "Bug Reports": "https://github.com/ByteTrix/media-player-scrobbler-for-simkl/issues",
        "Documentation": "https://github.com/ByteTrix/media-player-scrobbler-for-simkl/wiki",
        "Homepage": "https://github.com/ByteTrix/Media-Player-Scrobbler-for-Simkl",
        "Linux System Dependencies": "https://github.com/ByteTrix/Media-Player-Scrobbler-for-Simkl/wiki/Installation#linux-installation",
        "Repository": "https://github.com/ByteTrix/Media-Player-Scrobbler-for-Simkl"
    },
    "split_keywords": [
        "simkl",
        " scrobbler"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5bdb06eb68fc0705df3b6c7f3529c4e54e73a354ac4a5864307c3ff5deabbecc",
                "md5": "fd03650545a7027977906bca6765f7e7",
                "sha256": "d126277eb05f915526b4ddd5aef86418433b90deee763e70e2a4231b40c2877a"
            },
            "downloads": -1,
            "filename": "simkl_mps-2.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "fd03650545a7027977906bca6765f7e7",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<3.14,>=3.9",
            "size": 2257958,
            "upload_time": "2025-08-15T11:08:16",
            "upload_time_iso_8601": "2025-08-15T11:08:16.334969Z",
            "url": "https://files.pythonhosted.org/packages/5b/db/06eb68fc0705df3b6c7f3529c4e54e73a354ac4a5864307c3ff5deabbecc/simkl_mps-2.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "93c387424ca90526608014d2f76fb00eadf7df83b4a4c78653622bf69ad02aa0",
                "md5": "d7da4b5bdb27e0d3520072d65332cb88",
                "sha256": "d2768b5fcebbcd7ee88b1e8d306f9186bf0960d92635c145fd85fa2095464fb2"
            },
            "downloads": -1,
            "filename": "simkl_mps-2.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "d7da4b5bdb27e0d3520072d65332cb88",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<3.14,>=3.9",
            "size": 2174603,
            "upload_time": "2025-08-15T11:08:18",
            "upload_time_iso_8601": "2025-08-15T11:08:18.004757Z",
            "url": "https://files.pythonhosted.org/packages/93/c3/87424ca90526608014d2f76fb00eadf7df83b4a4c78653622bf69ad02aa0/simkl_mps-2.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-15 11:08:18",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "ByteTrix",
    "github_project": "Media-Player-Scrobbler-for-Simkl",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "simkl-mps"
}
        
Elapsed time: 0.63335s