episoder 0.12.0__tar.gz → 1.0.0__tar.gz

episoder-1.0.0/PKG-INFO

@@ -0,0 +1,110 @@
+Metadata-Version: 2.4
+Name: episoder
+Version: 1.0.0
+Summary: TV episode notifier
+Home-page: https://code.ott.net/episoder/
+Author: Stefan Ott
+Author-email: stefan@ott.net
+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
+Classifier: Topic :: Multimedia :: Video
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: COPYING
+Requires-Dist: argparse
+Requires-Dist: requests
+Requires-Dist: beautifulsoup4
+Requires-Dist: sqlalchemy>=2.0
+Provides-Extra: test
+Requires-Dist: mypy; extra == "test"
+Requires-Dist: flake8; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pyfakefs; extra == "test"
+Requires-Dist: types-requests; extra == "test"
+Provides-Extra: dev
+Requires-Dist: setuptools; extra == "dev"
+Dynamic: license-file
+
+# episoder
+
+![episoder](https://code.ott.net/episoder/screenshot.png "episoder 0.8.0")
+
+Episoder is a command-line tool that tells you about new episodes of your
+favourite TV shows. It gets its data from online TV episode guides such as
+epguides.com and TheTVDB.
+
+There is also a web frontend for episoder, called
+[webisoder](https://code.ott.net/webisoder).
+
+## Dependencies
+
+In order to use episoder, you need to have Python installed on your system. In
+addition to the default distribution, episoder uses the `requests`, `argparse`,
+`sqlalchemy` and `beautifulsoup4` packages.
+
+## Downloading
+
+The official website, bug tracker etc. for episoder can be found at
+[code.ott.net/episoder](https://code.ott.net/episoder/).
+
+## 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`.
+
+## Getting started
+
+First, find a show you're interested in:
+
+    $ episoder search firefly
+    ID	Name
+    -------	--------------------
+    78874	Firefly
+    384248	Firefly Lane
+    329088	Firefly (2017)
+
+Add that show to episoder:
+
+    $ episoder add 78874
+
+Update your database:
+
+    $ episoder update
+
+And finally show your episodes:
+
+    $ episoder list
+
+The list may be empty, by default episoder deletes old episodes and will only
+show you the next few days. The `--nodate` option to the `update` and `list`
+command will change that, in case you care about days long gone and/or far in
+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.
+
+## Using episoder
+
+To use episoder you will typically:
+
+* Create a cron job to update your database once a day using `episoder update`
+* Add `episoder list` to your `~/.bashrc`, `~/.bash_profile`, `/etc/bash.bashrc`
+  or `/etc/profile` if you want to see your upcoming shows every time you start
+  a shell. Consult your shell's documentation to find out which file to use.
+* Or run `episoder notify` at regular intervals to get notifications by e-mail.
+
+## More documentation
+
+There is some documentation to help you get started:
+
+* [Using episoder](https://code.ott.net/episoder/doc/use.html)
+* [Episoder configuration](https://code.ott.net/episoder/doc/config.html)

episoder-1.0.0/README.md

@@ -0,0 +1,77 @@
+# episoder
+
+![episoder](https://code.ott.net/episoder/screenshot.png "episoder 0.8.0")
+
+Episoder is a command-line tool that tells you about new episodes of your
+favourite TV shows. It gets its data from online TV episode guides such as
+epguides.com and TheTVDB.
+
+There is also a web frontend for episoder, called
+[webisoder](https://code.ott.net/webisoder).
+
+## Dependencies
+
+In order to use episoder, you need to have Python installed on your system. In
+addition to the default distribution, episoder uses the `requests`, `argparse`,
+`sqlalchemy` and `beautifulsoup4` packages.
+
+## Downloading
+
+The official website, bug tracker etc. for episoder can be found at
+[code.ott.net/episoder](https://code.ott.net/episoder/).
+
+## 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`.
+
+## Getting started
+
+First, find a show you're interested in:
+
+    $ episoder search firefly
+    ID	Name
+    -------	--------------------
+    78874	Firefly
+    384248	Firefly Lane
+    329088	Firefly (2017)
+
+Add that show to episoder:
+
+    $ episoder add 78874
+
+Update your database:
+
+    $ episoder update
+
+And finally show your episodes:
+
+    $ episoder list
+
+The list may be empty, by default episoder deletes old episodes and will only
+show you the next few days. The `--nodate` option to the `update` and `list`
+command will change that, in case you care about days long gone and/or far in
+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.
+
+## Using episoder
+
+To use episoder you will typically:
+
+* Create a cron job to update your database once a day using `episoder update`
+* Add `episoder list` to your `~/.bashrc`, `~/.bash_profile`, `/etc/bash.bashrc`
+  or `/etc/profile` if you want to see your upcoming shows every time you start
+  a shell. Consult your shell's documentation to find out which file to use.
+* Or run `episoder notify` at regular intervals to get notifications by e-mail.
+
+## More documentation
+
+There is some documentation to help you get started:
+
+* [Using episoder](https://code.ott.net/episoder/doc/use.html)
+* [Episoder configuration](https://code.ott.net/episoder/doc/config.html)

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

@@ -1,6 +1,6 @@
 # episoder, https://code.ott.net/episoder
 #
-# Copyright (C) 2004-2025 Stefan Ott. All rights reserved.
+# 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

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

@@ -1,6 +1,6 @@
 # episoder, https://code.ott.net/episoder
 #
-# Copyright (C) 2004-2024 Stefan Ott. All rights reserved.
+# 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
@@ -15,71 +15,76 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-from datetime import datetime
+from datetime import date, datetime
+from typing import Any, Optional
 
-from sqlalchemy import Column, Integer, Text, Date, ForeignKey, Sequence
-from sqlalchemy import DateTime, Boolean
-from sqlalchemy.orm import backref, declarative_base, relationship
+from sqlalchemy import Boolean, Date, DateTime, ForeignKey, Integer, Text
+from sqlalchemy import Sequence
+from sqlalchemy.orm import backref, DeclarativeBase, relationship
+from sqlalchemy.orm import mapped_column
 
-Base = declarative_base()
 
+# pylint: disable=too-few-public-methods
+class Base(DeclarativeBase):
+    pass
 
-class Show(Base):
 
+class Show(Base):
     RUNNING = 1
     SUSPENDED = 2
     ENDED = 3
 
     __tablename__ = "shows"
 
-    id = Column("show_id", Integer, Sequence("shows_show_id_seq"),
-                primary_key=True)
-    name = Column("show_name", Text)
-    url = Column(Text, unique=True)
-    updated = Column(DateTime)
-    enabled = Column(Boolean)
-    status = Column(Integer, default=RUNNING)
-
-    def __init__(self, name, url="", updated=datetime.fromtimestamp(0)):
-
+    id = mapped_column("show_id", Integer, Sequence("shows_show_id_seq"),
+                       primary_key=True)
+    name = mapped_column("show_name", Text)
+    url = mapped_column(Text, unique=True)
+    updated = mapped_column(DateTime)
+    enabled = mapped_column(Boolean)
+    status = mapped_column(Integer, default=RUNNING)
+
+    def __init__(self, name: str, url: str = "",
+                 updated: datetime = datetime.fromtimestamp(0)) -> None:
+        super().__init__()
         self.name = name
         self.url = url
         self.updated = updated
         self.status = Show.RUNNING
-        self.episodes = []
+        self.episodes: list[Episode] = []
         self.enabled = True
 
-    def __str__(self):
-
+    def __str__(self) -> str:
         return f"Show: {self.name}"
 
-    def __repr__(self):
-
+    def __repr__(self) -> str:
         return f'Show("{self.name}", "{self.url}")'
 
-    def __eq__(self, other):
+    def __eq__(self, other: object) -> Any:
+        if not isinstance(other, Show):
+            return NotImplemented
 
         return self.name == other.name and self.url == other.url
 
 
 # pylint: disable=too-many-instance-attributes
 class Episode(Base):
-
     __tablename__ = "episodes"
 
-    show_id = Column(Integer, ForeignKey(Show.id), primary_key=True)
-    episode = Column("num", Integer, primary_key=True)
-    airdate = Column(Date)
-    season = Column(Integer, primary_key=True)
-    title = Column(Text)
-    totalnum = Column(Integer)
-    prodnum = Column(Text)
-    notified = Column(Date)
+    show_id = mapped_column(Integer, ForeignKey(Show.id), primary_key=True)
+    episode = mapped_column("num", Integer, primary_key=True)
+    airdate = mapped_column(Date)
+    season = mapped_column(Integer, primary_key=True)
+    title = mapped_column(Text)
+    totalnum = mapped_column(Integer)
+    prodnum = mapped_column(Text)
+    notified = mapped_column(Date)
     show = relationship(Show, backref=backref("episodes", cascade="all"))
 
     # pylint: disable=too-many-arguments,too-many-positional-arguments
-    def __init__(self, name, season, episode, aired, prodnum, total):
-
+    def __init__(self, name: str, season: int, episode: int, aired: date,
+                 prodnum: Optional[str], total: int) -> None:
+        super().__init__()
         self.title = name
         self.season = int(season)
         self.episode = int(episode)
@@ -87,26 +92,28 @@ class Episode(Base):
         self.prodnum = prodnum
         self.totalnum = int(total)
 
-    def __lt__(self, other):
-
-        return ((self.season < other.season)
-                or ((self.season == other.season)
-                    and (self.episode < other.episode)))
-
-    def __str__(self):
-
+    def __str__(self) -> str:
         return f"{self.show.name} {self.season}x{self.episode:02d}: " \
                 f"{self.title}"
 
-    def __repr__(self):
-
+    def __repr__(self) -> str:
         airdate = self.airdate
 
         return f'Episode("{self.title}", {self.season}, {self.episode}, ' \
                f'date({airdate.year}, {airdate.month}, {airdate.day}), ' \
                f'"{self.prodnum}", {self.totalnum})'
 
-    def __eq__(self, other):
+    def __lt__(self, other: object) -> Any:
+        if not isinstance(other, Episode):
+            return NotImplemented
+
+        return ((self.season < other.season)
+                or ((self.season == other.season)
+                    and (self.episode < other.episode)))
+
+    def __eq__(self, other: object) -> Any:
+        if not isinstance(other, Episode):
+            return NotImplemented
 
         return (self.show_id == other.show_id
                 and self.season == other.season
@@ -114,15 +121,12 @@ class Episode(Base):
 
 
 class Meta(Base):
-
     __tablename__ = "meta"
-    key = Column(Text, primary_key=True)
-    value = Column(Text)
-
-    def __str__(self):
+    key = mapped_column(Text, primary_key=True)
+    value = mapped_column(Text)
 
+    def __str__(self) -> str:
         return f"Meta: {self.key} = {self.value}"
 
-    def __repr__(self):
-
+    def __repr__(self) -> str:
         return str(self)

{episoder-0.12.0 → episoder-1.0.0}/episoder/episoder.py

@@ -1,6 +1,6 @@
 # episoder, https://code.ott.net/episoder
 #
-# Copyright (C) 2004-2024 Stefan Ott. All rights reserved.
+# 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
@@ -20,7 +20,7 @@ from datetime import date, timedelta
 from typing import Optional
 
 import sqlite3
-from sqlalchemy import create_engine, or_, and_, select, inspect
+from sqlalchemy import create_engine, or_, and_, select, inspect, Table
 from sqlalchemy.orm import sessionmaker
 
 from .database import Episode, Show, Meta
@@ -45,12 +45,19 @@ class Database:
 
         # Initialize the database if all tables are missing
         names = [Show, Episode, Meta]
-        tables = [t for t in names if inspector.has_table(t.__table__.name)]
+        tables = [t for t in names
+                  if inspector.has_table(t.__table__.name)]  # type: ignore
 
         if len(tables) < 1:
+            assert isinstance(Show.__table__, Table)
             Show.__table__.create(bind=self.engine)
+
+            assert isinstance(Episode.__table__, Table)
             Episode.__table__.create(bind=self.engine)
+
+            assert isinstance(Meta.__table__, Table)
             Meta.__table__.create(bind=self.engine)
+
             self.set_schema_version(4)
 
     def open(self) -> None:
@@ -78,6 +85,8 @@ class Database:
 
     def get_schema_version(self) -> int:
         inspector = inspect(self.engine)
+
+        assert isinstance(Meta.__table__, Table)
         if not inspector.has_table(Meta.__table__.name):
             return 1
 
@@ -114,8 +123,13 @@ class Database:
             upgrade.execute("DROP TABLE shows")
             upgrade.close()
 
+            assert isinstance(Show.__table__, Table)
             Show.__table__.create(bind=self.engine)
+
+            assert isinstance(Episode.__table__, Table)
             Episode.__table__.create(bind=self.engine)
+
+            assert isinstance(Meta.__table__, Table)
             Meta.__table__.create(bind=self.engine)
 
             schema_version = 4

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

@@ -2,7 +2,7 @@
 
 # episoder, https://code.ott.net/episoder
 #
-# Copyright (C) 2004-2025 Stefan Ott. All rights reserved.
+# 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
@@ -65,7 +65,7 @@ class DatabaseWrapper:
         self._conn.close()
 
 
-def with_db(func: Callable) -> Callable:
+def with_db(func: Callable) -> Callable:  # type: ignore
     @functools.wraps(func)
     def wrapped(*args: str, **kwargs: str) -> Any:
         self = args[0]

{episoder-0.12.0 → episoder-1.0.0}/episoder/options.py

@@ -1,6 +1,6 @@
 # episoder, https://code.ott.net/episoder
 #
-# Copyright (C) 2004-2025 Stefan Ott. All rights reserved.
+# 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

{episoder-0.12.0 → episoder-1.0.0}/episoder/output.py

@@ -1,6 +1,6 @@
 # episoder, https://code.ott.net/episoder
 #
-# Copyright (C) 2004-2025 Stefan Ott. All rights reserved.
+# 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

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

@@ -1,6 +1,6 @@
 # episoder, https://code.ott.net/episoder
 #
-# Copyright (C) 2004-2024 Stefan Ott. All rights reserved.
+# 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

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

@@ -1,6 +1,6 @@
 # episoder, https://code.ott.net/episoder
 #
-# Copyright (C) 2004-2024 Stefan Ott. All rights reserved.
+# 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

{episoder-0.12.0 → episoder-1.0.0}/episoder/sources/parser.py

@@ -1,6 +1,6 @@
 # episoder, https://code.ott.net/episoder
 #
-# Copyright (C) 2004-2024 Stefan Ott. All rights reserved.
+# 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

{episoder-0.12.0 → episoder-1.0.0}/episoder/sources/thetvdb.py

@@ -1,6 +1,6 @@
 # episoder, https://code.ott.net/episoder
 #
-# Copyright (C) 2004-2024 Stefan Ott. All rights reserved.
+# 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
@@ -19,7 +19,7 @@ from abc import ABC, abstractmethod
 from json import dumps
 from logging import getLogger
 from datetime import datetime, date
-from typing import Dict, List, Tuple
+from typing import Any, Dict, List, Tuple
 
 from requests import Session
 
@@ -132,29 +132,29 @@ class TVDBOnline(TVDBState):
     def __repr__(self) -> str:
         return '<TVDBOnline>'
 
-    def _get(self, url: str, params: Dict) -> Dict:
+    def _get(self, url: str, params: Dict[str, Any]) -> Dict[str, Any]:
         url = f'https://api.thetvdb.com/{url}'
         head = {'Content-type': 'application/json',
                 'Authorization': f'Bearer {self._token}'}
 
         response = self._session.get(url, headers=head, params=params,
                                      timeout=10)
-        data = response.json()
+        data: Dict[str, Any] = response.json()
 
         if response.status_code == 404:
             raise TVDBShowNotFoundError(data.get('Error'))
 
         return data
 
-    def _get_episodes(self, show: Show,
-                      page: int) -> Tuple[List[Episode], Dict]:
+    def _get_episodes(self, show: Show, page: int) -> Tuple[
+            List[Dict[str, str]], Dict[str, int]]:
         show_id = int(show.url)
         opts = {'page': page}
         result = self._get(f'series/{show_id}/episodes', opts)
         return (result.get('data') or [], result.get('links', {}))
 
     def lookup(self, text: str) -> List[Show]:
-        def mkshow(entry: Dict) -> Show:
+        def mkshow(entry: Dict[str, str]) -> Show:
             name = entry.get('seriesName')
             assert isinstance(name, str)
             url = str(entry.get('id')).encode('utf8').decode('utf8')
@@ -167,7 +167,7 @@ class TVDBOnline(TVDBState):
         pass
 
     def _fetch_episodes(self, show: Show, page: int) -> List[Episode]:
-        def airdate(row: Dict) -> date:
+        def airdate(row: Dict[str, str]) -> date:
             aired = row.get('firstAired', '1970-01-01')
 
             if aired == '0000-00-00':
@@ -175,7 +175,7 @@ class TVDBOnline(TVDBState):
 
             return datetime.strptime(aired, '%Y-%m-%d').date()
 
-        def mkepisode(row: Dict) -> Episode:
+        def mkepisode(row: Dict[str, str]) -> Episode:
             num = int(row.get("airedEpisodeNumber", "0") or 0)
             name = row.get('episodeName') or 'Unnamed episode'
             season = int(row.get('airedSeason', '0') or 0)
@@ -185,12 +185,11 @@ class TVDBOnline(TVDBState):
             self._log.debug('Found episode %s', name)
             return Episode(name, season, num, aired, pnum, 0)
 
-        def is_valid(row: Dict) -> bool:
+        def is_valid(row: Dict[str, str]) -> bool:
             return row.get("firstAired") not in [None, ""]
 
         (data, links) = self._get_episodes(show, page)
-        valid: filter = filter(is_valid, data)
-        episodes = [mkepisode(row) for row in valid]
+        episodes = [mkepisode(row) for row in data if is_valid(row)]
 
         # handle pagination
         next_ = links.get("next") or 0

{episoder-0.12.0 → episoder-1.0.0}/episoder/sources/tvcom.py

@@ -1,6 +1,6 @@
 # episoder, https://code.ott.net/episoder
 #
-# Copyright (C) 2004-2024 Stefan Ott. All rights reserved.
+# 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

{episoder-0.12.0 → episoder-1.0.0}/episoder/version.py

@@ -1,6 +1,6 @@
 # episoder, https://code.ott.net/episoder
 #
-# Copyright (C) 2004-2025 Stefan Ott. All rights reserved.
+# 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
@@ -15,4 +15,4 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-__version__ = "0.12.0"
+__version__ = "1.0.0"