Skip to content sokS.O.K - Storage Organisation Kit
Universal Media Manager for organizing movies, TV series, music, books, and games. sok.__version__Version information for S.O.K sok.apisAPIs package for S.O.K. sok.apis.base_apiBase API client implementation. sok.apis.booksBooks APIs package. sok.apis.books.google_books_apiGoogle Books API implementation. sok.apis.books.open_library_apiOpen Library API implementation. sok.apis.gamesGames APIs package. sok.apis.games.igdb_apiIGDB (Internet Game Database) API implementation. sok.apis.games.rawg_apiRAWG API implementation. sok.apis.imagesImage API implementations for artwork and poster retrieval. sok.apis.images.fanart_apiFanart.tv API implementation. sok.apis.key_checkCheck that the key of a service works, with one light request. sok.apis.musicMusic APIs package sok.apis.music.deezer_apiDeezer API Implementation
Support for music search and metadata. sok.apis.music.lastfm_apiLast.fm API Implementation
Support for music search and metadata. sok.apis.music.musicbrainz_apiMusicBrainz API implementation. sok.apis.music.spotify_apiSpotify API Implementation sok.apis.videoVideo APIs Module for S.O.K sok.apis.video.imdb_apiIMDb API Implementation (via OMDb)
OMDb API (Open Movie Database) is a RESTful API for retrieving movie information. sok.apis.video.tmdb_apiTMDB API client implementation. sok.apis.video.tvdb_apiTVDB API Implementation
The TVDB (TheTVDB.com) is a community database for TV series. sok.configConfiguration package for S.O.K sok.config.api_registryAPI Registry - Centralized configuration of API services sok.config.config_managerConfiguration Manager for S.O.K sok.config.oauth_providersOAuth Providers - Authentication implementations for each service sok.config.session_managerSession Manager - Centralized management of sessions and API keys. sok.coreCore package for S.O.K. sok.core.adaptersAdapters for normalizing API responses. sok.core.adapters.media_adaptersMedia adapter registry and convenience functions. sok.core.adapters.media_adapters.baseBase adapter classes for API response normalization. sok.core.adapters.media_adapters.bookBook media adapter for API response normalization. sok.core.adapters.media_adapters.gameGame media adapter for API response normalization. sok.core.adapters.media_adapters.movieMovie media adapter for API response normalization. sok.core.adapters.media_adapters.musicMusic media adapter for API response normalization. sok.core.adapters.media_adapters.tvTV series media adapter for API response normalization. sok.core.batchBatch matching: find the online item of many files at once. sok.core.constantsApplication-wide constants and configuration keys. sok.core.desktop_entryDesktop integration of the Linux AppImage. sok.core.exceptionsCustom exceptions for the S.O.K. project. sok.core.historyRename history: what each rename did, and how to undo it. sok.core.interfacesCore interfaces and abstract base classes. sok.core.media_managerUniversal media manager for coordinating API access. sok.core.name_patternsInput patterns: how the user's file names are built. sok.core.securitySecurity utilities for application protection. sok.core.seriesWhat a TV series needs to be organized: its season folders and the
titles of its episodes. sok.core.updaterApplication update management. sok.core.utilsGeneral utility functions. sok.file_operationsFile operations management module for different media types. sok.file_operations.artworkPosters and covers saved next to the organized files. sok.file_operations.base_operationsBase operations common to all media types. sok.file_operations.book_operationsFile operations for electronic books. sok.file_operations.detectionDetection of the media type of files dropped in the app. sok.file_operations.game_operationsFile operations for video games. sok.file_operations.mixinsMixins for file operations. sok.file_operations.mixins.parsingParsing mixin for file operations. sok.file_operations.mixins.validationValidation mixin for file operations. sok.file_operations.music_operationsFile operations for music media. sok.file_operations.organizeOrganization of a list of files selected in the UI. sok.file_operations.subtitlesSubtitles that follow their video. sok.file_operations.video_operationsFile operations for video media (movies, series, documentaries). sok.mainMain entry point for S.O.K
Launches Qt GUI with modern interface sok.mediaMedia package for S.O.K. sok.media.base_mediaBase media class with API integration. sok.media.booksBooks media types package. sok.media.books.audiobookAudiobook class for audio book recordings. sok.media.books.bookBook class for physical and digital books. sok.media.books.comicComic class for comic books and graphic novels. sok.media.books.ebookEbook class for digital/electronic books. sok.media.factoryBuild the media items (Movie, Series, Album…) from search results. sok.media.gamesGames media types package. sok.media.games.dlcDLC class for downloadable content and game expansions. sok.media.games.gameGame class for video games. sok.media.musicMusic media types package. sok.media.music.albumAlbum media class for music organization. sok.media.music.artistArtist class for music artists. sok.media.music.playlistPlaylist class for music playlists. sok.media.music.trackTrack class for individual music tracks. sok.media.videoVideo media types package. sok.media.video.episodeEpisode class for TV series episodes. sok.media.video.movieMovie media class for video organization. sok.media.video.seriesTV Series media class for video organization. sok.organizeOrganize subpackage for S.O.K. sok.serverS.O.K Server: the web API of the Docker image, on the shared core (no Qt). sok.server.apiThe routes of the JSON API, under /api. sok.server.api.authAccount and session: /api/session, /api/setup, /api/login, /api/logout,
and the texts of the interface: /api/i18n. sok.server.api.eventsGET /api/events: the events of the server as server-sent events. sok.server.api.healthGET /api/health: the health check of Docker, without login. sok.server.api.renamesThe renames and the history: /api/renames, /api/renames/current,
/api/history, /api/history/{id}/undo, and the files already processed:
/api/processed and /api/processed/forget. sok.server.api.rowsThe rows of the tabs: /api/rows, /api/rows/{id}, /api/rows/{id}/search. sok.server.api.scansThe analyses: /api/scans, /api/scans/current and /api/to-check. sok.server.api.settingsThe settings: /api/settings, /api/settings/browse, /api/settings/test-link
and test-key. sok.server.api.watchThe automatic sorting: GET /api/watch. sok.server.api.webThe interface: the files of web/dist, built by Vite. sok.server.appThe FastAPI application of S.O.K Server, and its entry point (sok-server). sok.server.authThe account of S.O.K Server and its sessions. sok.server.dbThe database of S.O.K Server: sok.db, a SQLite file next to config.json. sok.server.eventsThe events of the server, sent live to the browsers (GET /api/events). sok.server.historyThe rename history of S.O.K Server, in the database, and the files
already processed. sok.server.jobsThe background work of S.O.K Server: one analysis or one rename at a time. sok.server.notifyThe notifications of S.O.K Server, after each rename that moved files. sok.server.renamesThe renames of S.O.K Server: the Ready rows of a tab go to their folder. sok.server.scansThe analyses of S.O.K Server: scan the source folders, sort the files,
search them. sok.server.searchThe search of the rows of S.O.K Server, and what the tabs show of them. sok.server.settingsThe settings of S.O.K Server. sok.server.watcherThe automatic sorting of S.O.K Server: the source folders are watched,
and the new files are analyzed and renamed on their own. Built with Kiln