episoder 1.0.0__tar.gz → 1.1.0__tar.gz

episoder-1.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include episoder.1
+include examples/home.episoder

{episoder-1.0.0 → episoder-1.1.0}/PKG-INFO

@@ -1,15 +1,15 @@
 Metadata-Version: 2.4
 Name: episoder
-Version: 1.0.0
+Version: 1.1.0
 Summary: TV episode notifier
 Home-page: https://code.ott.net/episoder/
 Author: Stefan Ott
 Author-email: stefan@ott.net
+License: GPL-3.0-or-later
 Project-URL: Source, https://git.ott.net/episoder/
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: End Users/Desktop
-Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
@@ -18,8 +18,9 @@ Requires-Python: >=3.6
 Description-Content-Type: text/markdown
 License-File: COPYING
 Requires-Dist: argparse
-Requires-Dist: requests
 Requires-Dist: beautifulsoup4
+Requires-Dist: platformdirs
+Requires-Dist: requests
 Requires-Dist: sqlalchemy>=2.0
 Provides-Extra: test
 Requires-Dist: mypy; extra == "test"
@@ -28,7 +29,9 @@ Requires-Dist: pytest; extra == "test"
 Requires-Dist: pyfakefs; extra == "test"
 Requires-Dist: types-requests; extra == "test"
 Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
 Requires-Dist: setuptools; extra == "dev"
+Requires-Dist: twine; extra == "dev"
 Dynamic: license-file
 
 # episoder
@@ -55,8 +58,9 @@ The official website, bug tracker etc. for episoder can be found at
 
 ## Installation
 
-You can install episoder by running `pip install episoder` or you can download
-the tarball from the official website, extract it and run `setup.py install`.
+You can install episoder from PyPI by running `pip install episoder` or you can
+download the tarball from the official website and install it manually using
+`pip install episoder-<version>.tar.gz`.
 
 ## Getting started
 
@@ -88,9 +92,10 @@ the future.
 
 ## Configuration
 
-The configuration file at `~/.episoder` contains your default settings for
-episoder. After installing episoder, the man page will help you with the
-configuration.
+Episoder does not need any configuration, it should run fine out of the box.
+Still, some of its behaviour can be tweaked through a config file at
+`~/.episoder`, the [man page](https://code.ott.net/episoder/doc/config.html) has
+all the details.
 
 ## Using episoder
 

{episoder-1.0.0 → episoder-1.1.0}/README.md

@@ -22,8 +22,9 @@ The official website, bug tracker etc. for episoder can be found at
 
 ## Installation
 
-You can install episoder by running `pip install episoder` or you can download
-the tarball from the official website, extract it and run `setup.py install`.
+You can install episoder from PyPI by running `pip install episoder` or you can
+download the tarball from the official website and install it manually using
+`pip install episoder-<version>.tar.gz`.
 
 ## Getting started
 
@@ -55,9 +56,10 @@ the future.
 
 ## Configuration
 
-The configuration file at `~/.episoder` contains your default settings for
-episoder. After installing episoder, the man page will help you with the
-configuration.
+Episoder does not need any configuration, it should run fine out of the box.
+Still, some of its behaviour can be tweaked through a config file at
+`~/.episoder`, the [man page](https://code.ott.net/episoder/doc/config.html) has
+all the details.
 
 ## Using episoder
 

episoder-1.1.0/episoder/cache.py

@@ -0,0 +1,49 @@
+# episoder, https://code.ott.net/episoder
+#
+# Copyright (C) 2004-2026 Stefan Ott. All rights reserved.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import os
+from typing import Optional
+
+_FILE_NAME_TVDB_TOKEN = "tvdb_token"
+
+
+class Cache:
+    def __init__(self, path: str) -> None:
+        self._path = path
+
+    def set_tvdb_token(self, token: str) -> None:
+        if not os.path.exists(self._path):
+            os.mkdir(self._path)
+
+        fn = os.path.join(self._path, _FILE_NAME_TVDB_TOKEN)
+        with open(fn, 'w', encoding='utf8') as file:
+            file.write(token)
+
+    def get_tvdb_token(self) -> Optional[str]:
+        fn = os.path.join(self._path, _FILE_NAME_TVDB_TOKEN)
+        if not os.path.exists(fn):
+            return None
+
+        with open(fn, 'r', encoding='utf8') as file:
+            token = file.read()
+
+        return token
+
+    def clear_tvdb_token(self) -> None:
+        fn = os.path.join(self._path, _FILE_NAME_TVDB_TOKEN)
+        if os.path.exists(fn):
+            os.unlink(fn)

{episoder-1.0.0 → episoder-1.1.0}/episoder/config.py

@@ -35,7 +35,7 @@ class EpisoderConfig:
         self.datafile = path.join(environ['HOME'], '.episodes')
         self.dateformat = '%a, %b %d, %Y'
         self.format = '%airdate %show %seasonx%epnum'
-        self.tvdb_key = '8F15287C4B23B36E'
+        self.tvdb_key = '1f4c52fc-410a-4868-9724-4c3eba19bdc7'
 
         self.email_to: Optional[str] = None
         self.email_username: Optional[str] = None

{episoder-1.0.0 → episoder-1.1.0}/episoder/database.py

@@ -86,11 +86,11 @@ class Episode(Base):
                  prodnum: Optional[str], total: int) -> None:
         super().__init__()
         self.title = name
-        self.season = int(season)
-        self.episode = int(episode)
+        self.season = season
+        self.episode = episode
         self.airdate = aired
         self.prodnum = prodnum
-        self.totalnum = int(total)
+        self.totalnum = total
 
     def __str__(self) -> str:
         return f"{self.show.name} {self.season}x{self.episode:02d}: " \

episoder-1.1.0/episoder/errors.py

@@ -0,0 +1,9 @@
+
+
+class RemoteError(Exception):
+    pass
+
+
+class NotAuthenticated(Exception):
+    def __init__(self) -> None:
+        super().__init__('Not authenticated')

{episoder-1.0.0 → episoder-1.1.0}/episoder/main.py

@@ -26,6 +26,9 @@ from datetime import date
 from traceback import print_exc
 from typing import Any, Callable, Optional
 
+from platformdirs import PlatformDirs
+
+from .cache import Cache
 from .config import ConfigLoader, EpisoderConfig
 from .database import Show
 from .episoder import Database
@@ -33,7 +36,8 @@ from .options import OptionsLoader
 from .output import ColorfulRenderer, ColorlessRenderer, EmailNotifier
 from .output import ConsoleRenderer, NewEpisodesNotification, SmtpTestMessage
 from .sources import parser_for, setup_sources
-from .sources.thetvdb import TVDB, TVDBShowNotFoundError
+from .sources.thetvdb_legacy import TVDBLegacy
+from .sources.thetvdb_v4 import TVDBv4
 
 
 def configure_logging(args: Namespace) -> None:
@@ -220,15 +224,12 @@ class Episoder:
 
     def search(self, keyword: str) -> None:
         tvdb = parser_for('123')  # numeric IDs are TVDB entries
-        assert isinstance(tvdb, TVDB)
-
-        try:
-            print('ID\tName\n-------\t--------------------')
-            for show in tvdb.lookup(keyword):
-                print(f'{show.url}\t{show.name}')
+        assert isinstance(tvdb, (TVDBLegacy, TVDBv4))
+        shows = tvdb.lookup(keyword)
 
-        except TVDBShowNotFoundError:
-            print('Nothing found')
+        print('ID\tName\n-------\t--------------------')
+        for show in shows:
+            print(f'{show.url}\t{show.name}')
 
     def _update_shows(self, shows: list[Show], after: Optional[date]) -> None:
         assert self.database is not None
@@ -237,8 +238,7 @@ class Episoder:
                 parser = parser_for(show.url)
                 assert parser is not None
                 parser.parse(show, self.database)
-            # pylint: disable=broad-exception-caught
-            except Exception:
+            except Exception:  # pylint: disable=broad-exception-caught
                 self._log.error('Error parsing %s', show)
                 print_exc()
                 self.database.rollback()
@@ -358,6 +358,9 @@ class CommandWrapper:
 
 
 def main() -> None:
+    dirs = PlatformDirs('episoder', 'cockroach')
+    cache = Cache(dirs.user_cache_dir)
+
     loader = OptionsLoader()
     options = loader.parse_cmdline(sys.argv[1:])
     loader.validate(options)
@@ -367,7 +370,7 @@ def main() -> None:
     cfg = config_loader.load(options.c)
     config_loader.validate(cfg)
 
-    setup_sources(cfg.agent, cfg.tvdb_key)
+    setup_sources(cfg.agent, cfg.tvdb_key, cache)
 
     command = CommandWrapper(options, cfg)
     command.run(options.func)

{episoder-1.0.0 → episoder-1.1.0}/episoder/sources/__init__.py

@@ -18,8 +18,10 @@
 from typing import Optional, List
 import requests
 
+from episoder.cache import Cache
 from .epguides import Epguides
-from .thetvdb import TVDB
+from .thetvdb_legacy import TVDBLegacy
+from .thetvdb_v4 import TVDBv4
 from .tvcom import TVCom
 from .parser import Parser
 
@@ -28,13 +30,14 @@ session = requests.Session()
 PARSERS: List[Parser] = []
 
 
-def setup_sources(user_agent: str, tvdb_api_key: str) -> None:
+def setup_sources(user_agent: str, tvdb_api_key: str, cache: Cache) -> None:
     session.headers.update({'User-Agent': user_agent})
 
     while len(PARSERS) > 0:
         PARSERS.pop()
 
-    PARSERS.append(TVDB(session, tvdb_api_key))
+    PARSERS.append(TVDBv4(session, tvdb_api_key, cache))
+    PARSERS.append(TVDBLegacy(session, tvdb_api_key))
     PARSERS.append(Epguides(session))
     PARSERS.append(TVCom())
 

{episoder-1.0.0 → episoder-1.1.0}/episoder/sources/epguides.py

@@ -140,7 +140,7 @@ class Epguides(Parser):
         then = self._get_date(day)
 
         # prodnum is None, we don't have those
-        return Episode(title, season, epnum, then, None, total)
+        return Episode(title, int(season), int(epnum), then, None, total)
 
     def _load_text_episode(self, line: str) -> Optional[Episode]:
         # Known formatting supported by this fine regex:

episoder-1.1.0/episoder/sources/thetvdb.py

@@ -0,0 +1,20 @@
+# episoder, https://code.ott.net/episoder
+#
+# Copyright (C) 2004-2026 Stefan Ott. All rights reserved.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+# Legacy keys use 16 digits
+KEYLEN_LEGACY = 16

episoder-1.0.0/episoder/sources/thetvdb.py → episoder-1.1.0/episoder/sources/thetvdb_legacy.py

@@ -20,14 +20,19 @@ from json import dumps
 from logging import getLogger
 from datetime import datetime, date
 from typing import Any, Dict, List, Tuple
+from sys import stderr
 
 from requests import Session
 
 from episoder.database import Episode, Show
 from episoder.episoder import Database
+from episoder.errors import RemoteError, NotAuthenticated
 from .parser import Parser
+from .thetvdb import KEYLEN_LEGACY
 
 
+# pylint: disable=duplicate-code
+
 class TVDBState(ABC):
     @abstractmethod
     def login(self, key: str) -> None:
@@ -42,23 +47,10 @@ class TVDBState(ABC):
         """Load episodes with this parser"""
 
 
-class InvalidLoginError(Exception):
-    pass
-
-
-class TVDBShowNotFoundError(Exception):
-    pass
-
-
-class TVDBNotLoggedInError(Exception):
-    pass
-
-
-class TVDB(Parser):
-    """Parser for episodes from thetvdb.com"""
+class TVDBLegacy(Parser):
+    """Parser for episodes from thetvdb.com legacy API"""
 
     def __init__(self, session: Session, api_key: str) -> None:
-        self._session = session
         self._api_key = api_key
         self._state: TVDBState = TVDBOffline(self, session)
 
@@ -66,7 +58,7 @@ class TVDB(Parser):
         return str(self._state)
 
     def __repr__(self) -> str:
-        return f'TVDB {repr(self._state)}'
+        return f'TVDBLegacy {repr(self._state)}'
 
     def lookup(self, text: str) -> List[Show]:
         self._state.login(self._api_key)
@@ -80,13 +72,13 @@ class TVDB(Parser):
         self._state = state
 
     def accept(self, url: str) -> bool:
-        return url.isdigit()
+        return url.isdigit() and len(self._api_key) <= KEYLEN_LEGACY
 
 
 class TVDBOffline(TVDBState):
-    def __init__(self, tvdb: TVDB, session: Session) -> None:
+    def __init__(self, tvdb: TVDBLegacy, session: Session) -> None:
         self._tvdb = tvdb
-        self._log = getLogger('TVDB (offline)')
+        self._log = getLogger('TVDBLegacy (offline)')
         self._session = session
 
     def __str__(self) -> str:
@@ -102,28 +94,36 @@ class TVDBOffline(TVDBState):
         response = self._session.post(url, body, headers=head, timeout=10)
         data = response.json()
 
-        if response.status_code == 401:
-            raise InvalidLoginError(data.get('Error'))
+        if response.status_code != 200:
+            raise RemoteError(data.get('Error'))
 
         self._log.info('Successful login')
         return data['token']
 
     def lookup(self, _: str) -> List[Show]:
-        raise TVDBNotLoggedInError()
+        raise NotAuthenticated()
 
     def login(self, key: str) -> None:
+        print("""** WARNING **
+You are using the legacy API for the TVDB. This API is deprecated and
+frequently broken.
+
+Please create a new API key for episoder on https://www.thetvdb.com/
+and update your configuration.
+        """, file=stderr)
+
         body = {'apikey': key}
         token = self._post_login(body)
         self._tvdb.change(TVDBOnline(token, self._session))
 
     def parse(self, _: Show, __: Database) -> None:
-        raise TVDBNotLoggedInError()
+        raise NotAuthenticated()
 
 
 class TVDBOnline(TVDBState):
     def __init__(self, token: str, session: Session) -> None:
         self._token = token
-        self._log = getLogger('TVDB (online)')
+        self._log = getLogger('TVDBLegacy (online)')
         self._session = session
 
     def __str__(self) -> str:
@@ -142,7 +142,7 @@ class TVDBOnline(TVDBState):
         data: Dict[str, Any] = response.json()
 
         if response.status_code == 404:
-            raise TVDBShowNotFoundError(data.get('Error'))
+            raise RemoteError(data.get('Error'))
 
         return data
 
@@ -160,8 +160,11 @@ class TVDBOnline(TVDBState):
             url = str(entry.get('id')).encode('utf8').decode('utf8')
             return Show(name, url=url)
 
-        matches = self._get('search/series', {'name': text})
-        return list(map(mkshow, matches.get('data', {})))
+        try:
+            matches = self._get('search/series', {'name': text})
+            return list(map(mkshow, matches.get('data', {})))
+        except RemoteError:
+            return []
 
     def login(self, _: str) -> None:
         pass
@@ -197,7 +200,7 @@ class TVDBOnline(TVDBState):
             try:
                 more = self._fetch_episodes(show, next_)
                 episodes.extend(more)
-            except TVDBShowNotFoundError:
+            except RemoteError:
                 msg = "Error parsing %s: failed to load page %d"
                 self._log.error(msg, show.name, next_)
 
@@ -221,7 +224,7 @@ class TVDBOnline(TVDBState):
         # load episodes
         try:
             episodes = self._fetch_episodes(show, 1)
-        except TVDBShowNotFoundError:
+        except RemoteError:
             return
 
         for (idx, episode) in enumerate(sorted(episodes)):