vsview-comp 0.1.0__tar.gz

vsview_comp-0.1.0/.gitignore

@@ -0,0 +1,224 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml
+
+# vsjet
+.vsjet/
+src/vsview/global_settings.json
+
+# VapourSynth inventory files
+vs_objects.inv
+vs_fixed.inv

vsview_comp-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jaded Encoding Thaumaturgy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

vsview_comp-0.1.0/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.4
+Name: vsview-comp
+Version: 0.1.0
+Summary: A vsview plugin to make comparison backed by Slowpoke Pics
+Project-URL: Source Code, https://github.com/Jaded-Encoding-Thaumaturgy/vs-view/tree/main/src/plugins/slowpics
+Project-URL: Bug Tracker, https://github.com/Jaded-Encoding-Thaumaturgy/vs-view/issues
+Project-URL: Contact, https://discord.gg/XTpc6Fa9eB
+Author-email: Jimbo <17926797+Kapppa@users.noreply.github.com>, Vardë <ichunjo.le.terrible@gmail.com>
+Maintainer-email: Vardë <ichunjo.le.terrible@gmail.com>, Jaded Encoding Thaumaturgy <jaded.encoding.thaumaturgy@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2025 Jaded Encoding Thaumaturgy
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: jinja2>=3.1.6
+Requires-Dist: pathvalidate
+Requires-Dist: vsjetpack>=1.0.0
+Requires-Dist: vsview[secrets]
+Description-Content-Type: text/markdown
+
+# vsview-comp
+
+A [vsview](https://github.com/Jaded-Encoding-Thaumaturgy/vs-view) plugin to make comparison backed by Slowpoke Pics.
+
+## Requirements
+
+- [vsview](https://github.com/Jaded-Encoding-Thaumaturgy/vs-view)
+- [vsjetpack](https://github.com/Jaded-Encoding-Thaumaturgy/vs-jetpack) 1.1.0 or later
+- [httpx](https://github.com/encode/httpx)
+
+## Installation
+
+```bash
+pip install vsview-comp
+```

vsview_comp-0.1.0/README.md

@@ -0,0 +1,15 @@
+# vsview-comp
+
+A [vsview](https://github.com/Jaded-Encoding-Thaumaturgy/vs-view) plugin to make comparison backed by Slowpoke Pics.
+
+## Requirements
+
+- [vsview](https://github.com/Jaded-Encoding-Thaumaturgy/vs-view)
+- [vsjetpack](https://github.com/Jaded-Encoding-Thaumaturgy/vs-jetpack) 1.1.0 or later
+- [httpx](https://github.com/encode/httpx)
+
+## Installation
+
+```bash
+pip install vsview-comp
+```

vsview_comp-0.1.0/pyproject.toml

@@ -0,0 +1,57 @@
+[build-system]
+requires = ["hatchling", "versioningit"]
+build-backend = "hatchling.build"
+
+[project]
+name = "vsview-comp"
+dynamic = ["version"]
+description = "A vsview plugin to make comparison backed by Slowpoke Pics"
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.12"
+authors = [
+    { name = "Jimbo", email = "17926797+Kapppa@users.noreply.github.com" },
+    { name = "Vardë", email = "ichunjo.le.terrible@gmail.com" },
+]
+maintainers = [
+    { name = "Vardë", email = "ichunjo.le.terrible@gmail.com" },
+    { name = "Jaded Encoding Thaumaturgy", email = "jaded.encoding.thaumaturgy@gmail.com" },
+]
+
+classifiers = [
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: OS Independent",
+    "Typing :: Typed",
+]
+dependencies = [
+    "vsview[secrets]",
+    "vsjetpack>=1.0.0",
+    "httpx>=0.28.1",
+    "pathvalidate",
+    "jinja2>=3.1.6",
+]
+
+[project.entry-points.vsview]
+vsview_comp = "vsview_comp"
+
+[project.urls]
+"Source Code" = "https://github.com/Jaded-Encoding-Thaumaturgy/vs-view/tree/main/src/plugins/slowpics"
+"Bug Tracker" = "https://github.com/Jaded-Encoding-Thaumaturgy/vs-view/issues"
+"Contact" = "https://discord.gg/XTpc6Fa9eB"
+
+[tool.uv.sources]
+vsview = { workspace = true }
+
+[tool.hatch.version]
+source = "versioningit"
+
+[tool.versioningit.vcs]
+match = ["comp/v*"]
+default-tag = "comp/v0.0.0"
+
+[tool.versioningit.tag2version]
+rmprefix = "comp/v"

vsview_comp-0.1.0/src/vsview_comp/__init__.py

@@ -0,0 +1,10 @@
+from typing import Any
+
+from vsview.api import WidgetPluginBase, hookimpl
+
+from .plugin import CompPlugin
+
+
+@hookimpl
+def vsview_register_toolpanel() -> type[WidgetPluginBase[Any, Any]]:
+    return CompPlugin

vsview_comp-0.1.0/src/vsview_comp/_metadata.py

@@ -0,0 +1,4 @@
+PLUGIN_ID = "jet_vsview_comp"
+PLUGIN_DISPLAY = "Comparison"
+LOGIN_CONTEXT = "slowpicslogin"
+COOKIE_KEY = "cookies.v1"

vsview_comp-0.1.0/src/vsview_comp/models.py

@@ -0,0 +1,204 @@
+from __future__ import annotations
+
+from collections import defaultdict
+from collections.abc import Sequence
+from logging import getLogger
+from pathlib import Path
+from typing import Any, Literal, NamedTuple, Self
+
+from jetpytools import classproperty
+from pydantic import BaseModel, ConfigDict, Field, ValidationError
+
+logger = getLogger(__name__)
+
+
+class ComparisonImage(NamedTuple):
+    path: Path
+    pict_type: str
+    frame_no: int
+    timestamp: str
+
+
+class ComparisonSource(NamedTuple):
+    name: str
+    images: Sequence[ComparisonImage]
+
+
+class TMDBGenre(BaseModel):
+    id: int
+    name: str
+
+
+class TMDBProductionCountry(BaseModel):
+    iso_3166_1: str = ""
+
+
+class LoggedBaseModel(BaseModel):
+    @classmethod
+    def validate_logged(cls, obj: Any, log_context: str) -> Self | None:
+        try:
+            return super().model_validate(obj)
+        except ValidationError as e:
+            logger.warning("Ignoring invalid payload in %s: %s", log_context, e)
+            logger.debug("Payload validation traceback", exc_info=True)
+            return None
+
+
+class TMDBTitleData(LoggedBaseModel):
+    model_config = ConfigDict(extra="allow")
+
+    id: int
+    name: str = ""
+    title: str = ""
+    original_name: str | None = None
+    original_title: str | None = None
+    original_language: str | None = None
+    origin_country: list[str] = Field(default_factory=list)
+    production_countries: list[TMDBProductionCountry] = Field(default_factory=list)
+    first_air_date: str | None = None
+    release_date: str | None = None
+    poster_path: str | None = None
+    overview: str | None = None
+    vote_average: float | None = None
+    vote_count: int | None = None
+    popularity: float | None = None
+    genre_ids: list[int] = Field(default_factory=list)
+    genres: list[TMDBGenre] = Field(default_factory=list)
+
+
+class TMDBPayload(LoggedBaseModel):
+    results: list[TMDBTitleData] = Field(default_factory=list)
+    genres: list[TMDBGenre] = Field(default_factory=list)
+
+
+class TMDBTooltipData(BaseModel):
+    header: str
+    original_name: str
+    genres: str
+    language: str
+    country: str
+    release_date: str
+    rating: str
+    popularity: str
+    tmdb_id: str
+    overview: str
+
+
+class TMDBTitle(BaseModel):
+    model_config = ConfigDict(ignored_types=(classproperty,))
+
+    data: TMDBTitleData
+    media_type: Literal["tv", "movie"]
+    genres: list[str] = Field(default_factory=list)
+
+    @property
+    def id(self) -> str:
+        """TMDB ID"""
+        return str(self.data.id)
+
+    @property
+    def name(self) -> str:
+        """Title name"""
+        return self.data.name if self.media_type == "tv" else self.data.title
+
+    @property
+    def original_name(self) -> str:
+        """Original title name"""
+        return self.data.original_name or self.data.original_title or "-"
+
+    @property
+    def year(self) -> str:
+        """Release year"""
+        release_date = self.data.first_air_date if self.media_type == "tv" else self.data.release_date
+        return (release_date or "0000")[:4]
+
+    @property
+    def media_tag(self) -> str:
+        """Media tag (TV or Movie)"""
+        return self.media_type.upper()
+
+    @property
+    def language(self) -> str:
+        """Original language"""
+        return (self.data.original_language or "-").upper()
+
+    @property
+    def country(self) -> str:
+        """Original country"""
+        return (
+            ", ".join(
+                [c for c in self.data.origin_country if c]
+                or [c.iso_3166_1 for c in self.data.production_countries if c.iso_3166_1]
+            )
+            or "-"
+        )
+
+    @property
+    def release_date(self) -> str:
+        """Release date"""
+        return (self.data.first_air_date or self.data.release_date or "-").strip()
+
+    @property
+    def rating(self) -> str:
+        """Rating"""
+        if self.data.vote_average is not None and self.data.vote_count is not None and self.data.vote_count > 0:
+            return f"{self.data.vote_average:.1f} ({self.data.vote_count} votes)"
+        else:
+            return "Not enough ratings"
+
+    @property
+    def popularity(self) -> str:
+        """Popularity"""
+        return f"{self.data.popularity:.2f}" if self.data.popularity is not None else "-"
+
+    @property
+    def overview(self) -> str:
+        """Overview"""
+        return (self.data.overview or "-").strip()
+
+    @property
+    def tooltip_data(self) -> TMDBTooltipData:
+        overview = self.overview
+        if len(overview) > 480:
+            overview = f"{overview[:477].rstrip()}..."
+
+        return TMDBTooltipData(
+            header=f"{self.name} ({self.year}) [{self.media_tag}]",
+            original_name=self.original_name,
+            genres=", ".join(self.genres) if self.genres else "-",
+            language=self.language,
+            country=self.country,
+            release_date=self.release_date,
+            rating=self.rating,
+            popularity=self.popularity,
+            tmdb_id=self.id,
+            overview=overview,
+        )
+
+    @classproperty
+    @classmethod
+    def supported_format_fields(cls) -> tuple[str, ...]:
+        return ("id", "name", "original_name", "year", "media_tag", "language", "country", "release_date")
+
+    @classproperty
+    @classmethod
+    def format_hints(cls) -> dict[str, str]:
+        hints = dict[str, str]()
+        for field in cls.supported_format_fields:
+            if not isinstance((prop := getattr(cls, field, None)), property):
+                logger.warning("Field %s is not a property", field)
+                continue
+
+            hints[field] = (prop.fget.__doc__ or "").strip()
+        return hints
+
+    def format_name(self, fmt: str, **extra: str) -> str:
+        """Format a name string using available TMDB fields and extra context."""
+
+        return fmt.format_map(
+            defaultdict(
+                str,
+                **{field: str(getattr(self, field)) for field in self.supported_format_fields},
+                **extra,
+            )
+        )