S.O.K developer documentation
S.O.K (Storage Organisation Kit) is a desktop app that identifies media files with online databases, then renames and moves them into a library that works with Plex, Jellyfin and Kodi. It handles movies, TV shows, music, books and games, on Windows, macOS and Linux.
This documentation is for people who work on the code. To use the app, see the user guide.
Where to start
Section titled “Where to start”- Set up a development environment: clone the repository, install the dependencies and run the app from source.
- First steps with the code: search a database from Python, the way the app does.
- Architecture: the layers of the app and how a search reaches an online database.
- Contributing: branches, commit messages, checks and pull requests.
- S.O.K Server: the Docker version with a web interface: running it, its API, its database, its interface, the automatic sorting and the notifications.
- API reference (at the bottom of the sidebar): every module, class and function, generated from the docstrings.
- Changelog: what changed in each version.
At a glance
Section titled “At a glance”| Language | Python 3.13 |
| Interface | PySide6 (Qt 6), built in code, no .ui files at run time |
| Network | aiohttp, one event loop per background worker |
| Packaging | Nuitka: Windows installer, macOS disk image, Linux AppImage |
| Dependencies | uv and pyproject.toml |
| License | MIT |