tvthekidx 0.5.0__tar.gz

tvthekidx-0.5.0/.gitignore

@@ -0,0 +1,10 @@
+*.py[cod]
+__pycache__/
+build/
+dist/
+eggs/
+*.egg*
+_version.py
+.ropeproject
+.vscode
+dev/

tvthekidx-0.5.0/CHANGELOG.md

@@ -0,0 +1,111 @@
+# Changelog
+
+## [0.5.0] - 2026-05-03
+
+### Added
+- Export plugin system — format selectable via `--format`; `html` and `text` plugins included
+- TV station detection — CNN-based identification of recording channel from screenshots; logos embedded in HTML export
+- Tags — regex-based file tagging with new `tags` subcommand (`list`, `add`, `delete`, `export`)
+- `maintenance` subcommand — replaces `database`; adds `detecttvstations`, `cleartvstations`, `getscreenshots`, `clearscreenshots` actions
+- `--graphics` export option — `embed` (base64 inline, default), `reference` (external files), `disable`
+- Clipboard copy button for filenames in HTML export
+- Director display in movie detail view
+- HTML generator meta tag
+
+### Changed
+- Database schema v8
+- HTML export ~7× faster — bulk SQL queries replace per-movie/per-file round-trips; SQLite mmap and page-cache tuning reduces system time by ~190×
+- CI pipeline upgraded to Debian trixie; win64 build removed; test matrix updated to bookworm and trixie
+- `--url` flag added to HTML exporter for video hyperlink prefix
+- Top list excludes 100%-scored movies
+- Cover size and new-section entry count adjusted
+- Sort order fixes for new section and movies-per-actor
+
+### Fixed
+- Badge width rendering
+- JavaScript search escaping and keybinding
+- Invalid TMDB ID query handling
+
+---
+
+## [0.4.0] - 2024-01-08
+
+### Added
+- Screenshot capture via ffprobe/moviepy
+- `database maintenance` command
+- File detail view for single-collection exports
+- MIT license
+
+### Changed
+- Restructured into Python package (`src/` layout) for use with setuptools
+- ffprobe used for video metadata extraction
+- Packaging switched to `pyproject.toml` / `python -m build`
+- Linter (flake8/pylint) added to CI
+
+---
+
+## [0.3.2] - 2023-08-23
+
+### Changed
+- PyInstaller version bump
+
+---
+
+## [0.3.1] - 2023-08-16
+
+### Added
+- Search keyboard shortcut
+
+---
+
+## [0.3.0] - 2023-08-15
+
+### Added
+- Simple full-text search in HTML export
+- Test of Linux binary on Debian bookworm
+
+---
+
+## [0.2.0] - 2023-07-24
+
+### Added
+- File size shown in collection hover tooltip
+- GitLab build pipeline
+
+### Changed
+- Movies-per-actor sort order updated
+
+---
+
+## [0.1.0] - 2022-11-30
+
+### Added
+- HTML navbar and "new releases" section
+- Merged scripts into single entry point
+
+### Changed
+- Switched from getopt to argparse
+- Increased entry count in new section
+
+---
+
+## [0.0.6] - 2022-02-19
+
+### Fixed
+- Word-break rendering and debug output removed
+
+---
+
+## [0.0.5] - 2022-02-16
+
+### Added
+- Collections support
+- Actors section
+- Non-TMDB files listed in output
+- Release pipeline
+- Custom header
+
+### Changed
+- Refactored codebase
+- Strict title matching; SQL escaping fixes
+- UTF-8 output enforced

tvthekidx-0.5.0/LICENSE

@@ -0,0 +1,169 @@
+TVThe(k)Idx
+
+Copyright (C) 2021-2026 developer@mplx.eu
+
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

tvthekidx-0.5.0/PKG-INFO

@@ -0,0 +1,189 @@
+Metadata-Version: 2.1
+Name: tvthekidx
+Version: 0.5.0
+Summary: maintain an index of downloaded tvthek content
+Project-URL: Homepage, https://gitlab.mplx.eu/scripts/tvthekidx
+Project-URL: Source, https://gitlab.mplx.eu/scripts/tvthekidx
+Author-email: mplx <developer@mplx.eu>
+License: LGPL-3.0-only
+Keywords: movies,tvthek
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
+Requires-Dist: ffmpeg-python==0.2.0
+Requires-Dist: moviepy==1.0.3
+Requires-Dist: pillow==12.2.0
+Requires-Dist: tmdbv3api==1.7.7
+Provides-Extra: tvstation
+Requires-Dist: ultralytics==8.4.22; extra == 'tvstation'
+Description-Content-Type: text/markdown
+
+# TVthe(k)Index
+
+Generates an index of tvthek/mediathek downloaded content and queries [TMDB](https://www.themoviedb.org/) for the meta data
+
+![TVthe(k)Index Logo](./docs/assets/tvthekidx.png)
+
+## Example
+
+[![TVthe(k)Index Sample](./docs/assets/sample.png)](https://peach.blender.org/)
+
+## Usage (version 0.5.0)
+
+### Prerequisites
+
+Register at [TMDB](https://www.themoviedb.org/) and [get an API key](https://www.themoviedb.org/documentation/api).
+
+### from binary (windows)
+
+1. download binaries from [packages](https://gitlab.mplx.eu/scripts/tvthekidx/-/packages) and rename to `tvthekidx.exe`
+
+2. create database
+
+`tvthekidx.exe -v maintenance -d tvthek.db -a createdb`
+
+3. run the indexer
+
+`tvthekidx.exe -v index -k "APIKEY" -d tvthek.db -t movies -c "TVthek" -p x:\TVThek --recursive`
+
+(insert your TMDB API key instead of `APIKEY`)
+
+4. generate the html file
+
+`tvthekidx.exe export -d tvthek.db -c "TVthek" -f html --title "TVthek" --output tvthek.html`
+
+5. if you add or remove content run steps 3 + 4 again
+
+6. occasionally run database maintenance
+
+`tvthekidx.exe -v maintenance -d tvthek.db -a compressdb`
+
+### from binary (linux)
+
+1. download binaries from [packages](https://gitlab.mplx.eu/scripts/tvthekidx/-/packages) and rename to `tvthekidx`
+
+2. make tvthekidx executable
+
+`chmod +x tvthekidx`
+
+3. create database
+
+`./tvthekidx -v maintenance -d tvthek.db -a createdb`
+
+4. run the indexer
+
+`./tvthekidx -v index -k "APIKEY" -d tvthek.db -t movies -c "TVthek" -p /mnt/TVThek/ --recursive`
+
+(insert your TMDB API key instead of `APIKEY`)
+
+5. generate the html file
+
+`./tvthekidx export -d tvthek.db -c "TVthek" -f html --title "TVthek" --output tvthek.html`
+
+6. if you add or remove content run steps 4 + 5 again
+
+7. occasionally run database maintenance
+
+`./tvthekidx -v maintenance -d tvthek.db -a compressdb`
+
+### from python source
+
+1. download source code from [releases](https://gitlab.mplx.eu/scripts/tvthekidx/-/releases)
+
+2. install requirements
+
+`pip install -e .`
+
+3. create database
+
+`tvthekidx -v maintenance -d tvthek.db -a createdb`
+
+4. run the indexer
+
+`tvthekidx -v index -k "APIKEY" -d tvthek.db -t movies -c "TVthek" -p /mnt/TVThek/ --recursive`
+
+(insert your TMDB API key instead of `APIKEY`)
+
+5. generate the html file
+
+`tvthekidx export -d tvthek.db -c "TVthek" -f html --title "TVthek" --output tvthek.html`
+
+6. if you add or remove content run steps 4 + 5 again
+
+7. occasionally run database maintenance
+
+`tvthekidx -v maintenance -d tvthek.db -a compressdb`
+
+## Global arguments
+
+- `-q`, `--quiet` quiet (set verbose to 0)
+- `-v`, `--verbose` increase verbosity (stackable)
+
+## `index` arguments
+
+- `-d`, `--database` SQLite database file
+- `-p`, `--path` path to scan for video files
+- `-k`, `--key` TMDB API key
+- `-t`, `--type` content type (`movies`; tvshows not yet supported)
+- `-c`, `--collection` collection name
+- `-r`, `--recursive` scan subdirectories recursively
+
+## `export` arguments
+
+- `-d`, `--database` SQLite database file
+- `-c`, `--collection` comma-separated list of collections to include
+- `-f`, `--format` export format plugin (`html`, `text`); default `html`
+
+### HTML plugin arguments (passed after `export`)
+
+- `--title` page title
+- `--output`, `-o` output file (default `tvthek.html`)
+- `--graphics` image handling: `embed` (default, base64 inline), `reference` (external files), `disable`
+- `--skip-actors` omit the actors/crew section
+- `--skip-header` omit the top-rated and newest-additions header sections
+- `--url` hyperlink prefix for video file links (default `./`)
+
+## `maintenance` arguments
+
+- `-d`, `--database` SQLite database file
+- `-a`, `--action` one of:
+  - `createdb` — create a new database
+  - `upgradedb` — run schema migrations on an existing database
+  - `compressdb` — deduplicate movies and VACUUM
+  - `detecttvstations` — run ML-based TV station detection on stored screenshots
+  - `cleartvstations` — remove all TV station assignments
+  - `getscreenshots` — capture/backfill screenshots for files (requires `-p`)
+  - `clearscreenshots` — delete all stored screenshots
+- `-p`, `--path` path to video files (required for `getscreenshots`)
+- `-c`, `--collection` collection filter (optional for `getscreenshots`)
+
+## `tags` arguments
+
+- `-d`, `--database` SQLite database file
+- `-a`, `--action` one of: `list`, `add`, `delete`, `export`
+- `-t`, `--tag` tag name
+- `-r`, `--regex` regular expression pattern matched against filenames
+- `--all` delete all tags (use with `--action delete`)
+
+## What's new in 0.5.0
+
+- **Export plugin system** — export format is now selectable via `--format`; `html` and `text` plugins included
+- **TV station detection** — screenshots are analysed with a convolutional neural network (CNN) to identify the recording channel; logos are embedded in the HTML export
+- **Tags** — regex-based file tagging with the new `tags` subcommand
+- **`maintenance` subcommand** — replaces `database`; adds `detecttvstations`, `cleartvstations`, `getscreenshots`, `clearscreenshots` actions
+- **`--graphics` export option** — choose between embedded base64, external file references, or disabled images
+- **HTML export performance** — ~7× faster; bulk SQL queries replace per-movie/per-file round-trips; SQLite mmap and page-cache tuning cuts system time by ~190×
+- **Database schema v8** — all binary attachments (posters, actor profiles, screenshots) unified in a single `attachments` table with a composite index on `(ref_id, type)`
+- **CI pipeline upgraded to Debian trixie** — build image updated to `python:3-slim-trixie`; test matrix updated to bookworm and trixie; win64 removed

tvthekidx-0.5.0/README.md

@@ -0,0 +1,157 @@
+# TVthe(k)Index
+
+Generates an index of tvthek/mediathek downloaded content and queries [TMDB](https://www.themoviedb.org/) for the meta data
+
+![TVthe(k)Index Logo](./docs/assets/tvthekidx.png)
+
+## Example
+
+[![TVthe(k)Index Sample](./docs/assets/sample.png)](https://peach.blender.org/)
+
+## Usage (version 0.5.0)
+
+### Prerequisites
+
+Register at [TMDB](https://www.themoviedb.org/) and [get an API key](https://www.themoviedb.org/documentation/api).
+
+### from binary (windows)
+
+1. download binaries from [packages](https://gitlab.mplx.eu/scripts/tvthekidx/-/packages) and rename to `tvthekidx.exe`
+
+2. create database
+
+`tvthekidx.exe -v maintenance -d tvthek.db -a createdb`
+
+3. run the indexer
+
+`tvthekidx.exe -v index -k "APIKEY" -d tvthek.db -t movies -c "TVthek" -p x:\TVThek --recursive`
+
+(insert your TMDB API key instead of `APIKEY`)
+
+4. generate the html file
+
+`tvthekidx.exe export -d tvthek.db -c "TVthek" -f html --title "TVthek" --output tvthek.html`
+
+5. if you add or remove content run steps 3 + 4 again
+
+6. occasionally run database maintenance
+
+`tvthekidx.exe -v maintenance -d tvthek.db -a compressdb`
+
+### from binary (linux)
+
+1. download binaries from [packages](https://gitlab.mplx.eu/scripts/tvthekidx/-/packages) and rename to `tvthekidx`
+
+2. make tvthekidx executable
+
+`chmod +x tvthekidx`
+
+3. create database
+
+`./tvthekidx -v maintenance -d tvthek.db -a createdb`
+
+4. run the indexer
+
+`./tvthekidx -v index -k "APIKEY" -d tvthek.db -t movies -c "TVthek" -p /mnt/TVThek/ --recursive`
+
+(insert your TMDB API key instead of `APIKEY`)
+
+5. generate the html file
+
+`./tvthekidx export -d tvthek.db -c "TVthek" -f html --title "TVthek" --output tvthek.html`
+
+6. if you add or remove content run steps 4 + 5 again
+
+7. occasionally run database maintenance
+
+`./tvthekidx -v maintenance -d tvthek.db -a compressdb`
+
+### from python source
+
+1. download source code from [releases](https://gitlab.mplx.eu/scripts/tvthekidx/-/releases)
+
+2. install requirements
+
+`pip install -e .`
+
+3. create database
+
+`tvthekidx -v maintenance -d tvthek.db -a createdb`
+
+4. run the indexer
+
+`tvthekidx -v index -k "APIKEY" -d tvthek.db -t movies -c "TVthek" -p /mnt/TVThek/ --recursive`
+
+(insert your TMDB API key instead of `APIKEY`)
+
+5. generate the html file
+
+`tvthekidx export -d tvthek.db -c "TVthek" -f html --title "TVthek" --output tvthek.html`
+
+6. if you add or remove content run steps 4 + 5 again
+
+7. occasionally run database maintenance
+
+`tvthekidx -v maintenance -d tvthek.db -a compressdb`
+
+## Global arguments
+
+- `-q`, `--quiet` quiet (set verbose to 0)
+- `-v`, `--verbose` increase verbosity (stackable)
+
+## `index` arguments
+
+- `-d`, `--database` SQLite database file
+- `-p`, `--path` path to scan for video files
+- `-k`, `--key` TMDB API key
+- `-t`, `--type` content type (`movies`; tvshows not yet supported)
+- `-c`, `--collection` collection name
+- `-r`, `--recursive` scan subdirectories recursively
+
+## `export` arguments
+
+- `-d`, `--database` SQLite database file
+- `-c`, `--collection` comma-separated list of collections to include
+- `-f`, `--format` export format plugin (`html`, `text`); default `html`
+
+### HTML plugin arguments (passed after `export`)
+
+- `--title` page title
+- `--output`, `-o` output file (default `tvthek.html`)
+- `--graphics` image handling: `embed` (default, base64 inline), `reference` (external files), `disable`
+- `--skip-actors` omit the actors/crew section
+- `--skip-header` omit the top-rated and newest-additions header sections
+- `--url` hyperlink prefix for video file links (default `./`)
+
+## `maintenance` arguments
+
+- `-d`, `--database` SQLite database file
+- `-a`, `--action` one of:
+  - `createdb` — create a new database
+  - `upgradedb` — run schema migrations on an existing database
+  - `compressdb` — deduplicate movies and VACUUM
+  - `detecttvstations` — run ML-based TV station detection on stored screenshots
+  - `cleartvstations` — remove all TV station assignments
+  - `getscreenshots` — capture/backfill screenshots for files (requires `-p`)
+  - `clearscreenshots` — delete all stored screenshots
+- `-p`, `--path` path to video files (required for `getscreenshots`)
+- `-c`, `--collection` collection filter (optional for `getscreenshots`)
+
+## `tags` arguments
+
+- `-d`, `--database` SQLite database file
+- `-a`, `--action` one of: `list`, `add`, `delete`, `export`
+- `-t`, `--tag` tag name
+- `-r`, `--regex` regular expression pattern matched against filenames
+- `--all` delete all tags (use with `--action delete`)
+
+## What's new in 0.5.0
+
+- **Export plugin system** — export format is now selectable via `--format`; `html` and `text` plugins included
+- **TV station detection** — screenshots are analysed with a convolutional neural network (CNN) to identify the recording channel; logos are embedded in the HTML export
+- **Tags** — regex-based file tagging with the new `tags` subcommand
+- **`maintenance` subcommand** — replaces `database`; adds `detecttvstations`, `cleartvstations`, `getscreenshots`, `clearscreenshots` actions
+- **`--graphics` export option** — choose between embedded base64, external file references, or disabled images
+- **HTML export performance** — ~7× faster; bulk SQL queries replace per-movie/per-file round-trips; SQLite mmap and page-cache tuning cuts system time by ~190×
+- **Database schema v8** — all binary attachments (posters, actor profiles, screenshots) unified in a single `attachments` table with a composite index on `(ref_id, type)`
+- **CI pipeline upgraded to Debian trixie** — build image updated to `python:3-slim-trixie`; test matrix updated to bookworm and trixie; win64 removed