episoder 0.10.1__tar.gz → 0.11.0__tar.gz

episoder-0.11.0/.gitignore

@@ -0,0 +1,2 @@
+*.pyc
+*.swp

episoder-0.11.0/.gitlab-ci.yml

@@ -0,0 +1,107 @@
+stages:
+  - test
+  - deploy
+
+.jammy_image: &jammy
+  image: registry.gitlab.com/schabe/episoder:ubuntu-jammy
+
+.bookworm_image: &bookworm
+  image: registry.gitlab.com/schabe/episoder:debian-bookworm
+
+.noble_image: &noble
+  image: registry.gitlab.com/schabe/episoder:ubuntu-noble
+
+.test_template: &test_installed_setuptools
+  stage: test
+  script:
+    - python3 setup.py install
+    - python3 -m pytest --junitxml=report.xml --cov=episoder/
+    - python3 -m coverage xml
+  artifacts:
+    reports:
+      junit: report.xml
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+
+.test_template: &test
+  stage: test
+  script:
+    - python3 -m pytest --junitxml=report.xml --cov=episoder/
+    - python3 -m coverage xml
+  artifacts:
+    reports:
+      junit: report.xml
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage.xml
+
+.deploy_setuptools_template: &deploy_setuptools
+  stage: deploy
+  script:
+    - python3 setup.py install
+    - python3 setup.py sdist
+    - python3 setup.py bdist_egg
+    - episoder --version
+
+.deploy_pip_template: &deploy_pip
+  stage: deploy
+  script:
+    - pip install .
+    - episoder --version
+
+.deploy_setuptools_venv_template: &deploy_pip_venv
+  stage: deploy
+  script:
+    - python3 -m venv --system-site-packages venv
+    - venv/bin/python3 setup.py install
+    - venv/bin/python3 setup.py sdist
+    - venv/bin/python3 setup.py bdist_egg
+    - venv/bin/episoder --version
+
+.deploy_pip_venv_template: &deploy_pip_venv
+  stage: deploy
+  script:
+    - python3 -m venv --system-site-packages venv
+    - venv/bin/pip install .
+    - venv/bin/episoder --version
+
+py310-jammy:test:
+  <<: *jammy
+  <<: *test
+
+py310-jammy-setuptools:deploy:
+  <<: *jammy
+  <<: *deploy_setuptools
+
+py310-jammy-pip:deploy:
+  <<: *jammy
+  <<: *deploy_pip
+
+py311-bookworm:test:
+  <<: *bookworm
+  <<: *test
+
+py311-bookworm-setuptools:deploy:
+  needs: ["py311-bookworm:test"]
+  <<: *bookworm
+  <<: *deploy_setuptools
+
+py311-bookworm-pip:deploy:
+  needs: ["py311-bookworm:test"]
+  <<: *bookworm
+  <<: *deploy_pip_venv
+
+py312-noble:test:
+  <<: *noble
+  <<: *test
+
+py312-noble-setuptools:deploy:
+  needs: ["py312-noble:test"]
+  <<: *noble
+  <<: *deploy_setuptools
+
+py312-noble-pip:deploy:
+  needs: ["py312-noble:test"]
+  <<: *noble
+  <<: *deploy_pip_venv

episoder-0.11.0/CHANGELOG

@@ -0,0 +1,219 @@
+== 0.11.0 (20 Jul 2024) ==
+ * Port to sqlalchemy 2.0
+
+== 0.10.1 (17 May 2023) ==
+ * tvdb: Fix a crash on shows with an empty 'data' field
+ * epguides: Fix parsing of cancelled/ended shows
+
+== 0.10.0 (25 Mar 2023) ==
+ * Fix a crash when trying to render shows without a name
+ * Explicitly depend on sqlalchemy 1.3/1.4
+ * Fix code that sets the database schema version
+ * Rename package from pyepisoder to episoder
+ * Update distribution scripts
+
+== 0.9.2 (1 Jan 2021) ==
+ * Fix a crash when trying to render episodes without production number
+ * Use appropriate colors when showing episodes from a past date
+ * Fix formatting of show names in list of shows
+ * Accept empty episode lines in epguide HTML format parser
+
+== 0.9.1 (11 Oct 2020) ==
+ * Fix setup.py
+
+== 0.9.0 (11 Oct 2020) ==
+ * Add support for new HTML format on epguides.com (thanks to Jethro Beekman)
+
+== 0.8.5 (28 Mar 2020) ==
+ * Fix a small bug in setup.py
+
+== 0.8.4 (28 Mar 2020) ==
+ * Fix loading of shows without episodes from TVDB
+ * Fix loading of episodes with invalid date (0000-00-00)
+
+== 0.8.3 (27 Sep 2017) ==
+ * Fixed a crash related to unexpected null values in TVDB JSON data
+ * Use correct path for example config file in setup.py (fixes #7)
+
+== 0.8.2 (7 Jul 2017) ==
+ * Fixed a crash when rendering episodes without a title
+
+== 0.8.1 (24 Jun 2017) ==
+ * Handle failures to load TVDB API pages
+
+== 0.8.0 (7 Jun 2017) ==
+ * Switched from distutils to setuptools
+ * We now use the new TVDB JSON API
+ * Rewrote the epguides.com parser in pure Python
+ * Rewrote large parts of the database code
+ * Episoder should now work fully with Python 3
+ * The update command can now be limited to a fixed number of shows
+ * Updated man page
+ * Thanks to Chris Spencer (chrisspen) for his contributions
+ * Added option to only list active shows (chrisspen)
+ * Added the number of episodes to the list of shows (chrisspen)
+ * Added email notification feature via 'episoder notify' (chrisspen)
+
+== 0.7.3 (7 Nov 2015) ==
+ * Fixed a syntax error in the list of shows
+ * Fixed season number parsing for epguides.com (thanks to jethrogb)
+
+== 0.7.2 (26 Sep 2015) ==
+ * Dropped unneeded dependency on BeautifulSoup
+ * Fixed episode number parsing for epguides.com (thanks to jethrogb)
+ * Improved python3 compatibility
+
+== 0.7.1 (27 Apr 2014) ==
+ * Accept unicode characters in prodnum fields
+
+== 0.7.0 (14 Oct 2013) ==
+ * Added support for TheTVDB.com
+ * Removed support for tv.com
+ * Changed command-line arguments. See the man page for details
+ * Removed the ability to specify shows in the configuration file
+ * Reorganized the command line options. Check the documentation for details
+ * Updated the epguides.com parser to ignore trailer links in episode names
+ * Fixed some more encoding issues in the console renderer
+ * Changed license to GPLv3
+
+== 0.6.5 (6 Oct 2010) ==
+ * Updated the epguides.com parser to ignore links to trailers in episode names
+
+== 0.6.4 (25 Jun 2010) ==
+ * Filter javascript from tv.com pages because it confuses beautifulsoup 3.1
+
+== 0.6.3 (23 Jun 2010) ==
+ * The epguides parser now properly reads the season number for more shows
+
+== 0.6.2 (08 Nov 2009) ==
+ * Updated tv.com parser (show names need to be lower-case now!)
+ * Added -S option to specify a show id for (forced) updates
+
+== 0.6.1 (26 Aug 2009) ==
+ * Episoder can now talk to any database supported by sqlalchemy (see README)
+ * Tell awk to process utf8 (for epguides parser)
+ * Catch (and properly log) some more HTTP exceptions
+
+== 0.6.0 (8 Aug 2009) ==
+ * Episoder now keeps a persistent database of shows and episodes
+ * Added new options (-L, -a, -r, -E, -D) to manage the database
+ * The parsers now know whether a show is still running or not
+   * Active (currently running) shows are updated every two days
+   * Inactive (ended) shows are updated every two weeks
+   * The new -B command overrides those intervals and forces an update
+ * Show names can no longer be overridden in the configuration file
+ * Don't report an error when no sources are defined in the config file
+ * The tv.com parser now also accepts urls containing '!', '+' or '%'
+ * The -d option now also accepts the number of days instead of a fixed date
+ * Documentation updated
+
+== 0.5.3 (26 Jul 2009) ==
+ * Added support for another epguides formatting style (used eg. for "Eureka")
+ * Added option to suppress colors in console output
+ * Added a filter to remove invalid characters from epguides content
+ * Fixed some other parsing issues in the epguides parser
+ * Improved compatibility with older python versions
+
+== 0.5.2 (30 Jun 2009) ==
+ * Reworked parts of the code to improve compatibility with older libraries
+ * Fixed some encoding issues in the console renderer
+
+== 0.5.1 (23 Jun 2009) ==
+ * Thanks to Philip Douglass for his bug reports and patches
+ * The epguides parser now properly closes all file handles and works with mawk
+ * The tv.com parser would crash on missing production/season/episode numbers
+ * The tv.com parser now accepts urls that contain a dash
+ * Switched to using sqlalchemy to access the database
+ * Properly implemented the user-agent configuration option
+ * Removed old FAQ
+ * Fixed some text encoding issues
+ * Small fixes to the man page
+
+== 0.5.0 (18 May 2009) ==
+ * Rewrote the whole thing in python
+ * Wrote a brand new tv.com parser
+ * Small fixes in the epguides.com parser
+ * Parsed data is now stored in an sqlite3 database
+
+== 0.4.7 (24 Feb 2007) ==
+ * Fixed a parsing issue introduced with 0.4.6
+
+== 0.4.6 (24 Feb 2007) ==
+ * Discovered yet another formatting possibility on epguides.com (used for
+   instance for the show "Midsomer Murders") and adapted the parser accordingly
+ * Slightly updated the man page
+
+== 0.4.5 (23 Jan 2007) ==
+ * Fixed some epguides parser issues
+
+== 0.4.4 (19 Nov 2006) ==
+ * Fixed the -i option when building the database (did the exact opposite of
+   what it was supposed to do)
+
+== 0.4.3 (24 Oct 2006) ==
+ * We now actually honor the -i option when building the database
+ * Added the possibility to override a show's name in the config file. This was needed for the new webisoder, a web-based episoder. Find out more about it at http://www.webisoder.net/
+ * Oops, forgot to update episoder's version number in the last release...
+ * Fixed a bug in the new epguides.com parser which would not drop episodes without a date
+
+== 0.4.2 (21 Oct 2006) ==
+ * Don't ignore the config file passed with -c anymore when building the db
+ * Added parser for epguides.com (closes #38)
+
+== 0.4.1 (20 Apr 2006) ==
+ * Did some minor internal changes to get episoder to work on non-linux systems
+ * Removed long options
+ * Hotfix for the tv.com website changes
+
+== 0.4.0 (3 Dec 2005) ==
+ * Re-organized options: -vv is now -w, -rc is now -c (or --rc), -nd is gone (use --nodate), -sa is gone (use -s and --nodate instead), -i is gone (see below)
+ * Search is now alway case-insensitive
+ * If no action is specified, episoder now defaults to showlist
+ * Removed the tvtome dummy plugin
+
+== 0.3.0 (9 Aug 2005) ==
+ * Majeed Goldrick joined the project
+ * Moved parts of the website to sourceforge
+ * Removed a 1024-episodes-limit in sortlist
+ * Added search options
+ * Switched to awk to remove old episodes (>600 times faster)
+ * Switched to awk for tv.com parsing (>10 times faster)
+ * Removed the debian files from the main distribution
+ * Added a couple of tests
+
+== 0.2.5 (19 Jul 2005) ==
+ * Fixed an alignment problem in showlist (closes #25)
+ * Fixed a date-calculation issue in showlist (closes #23)
+ * Fixed a documentation mistake about the format string (closes #21)
+ * Added support for nun-numeric episode numbers (closes #24)
+
+== 0.2.4 (19 Jul 2005) ==
+ * Re-arranged the code to remove a 3-episodes-limit in showlist (closes #19)
+ * Added command line option to specify the number of days to show (closes #20)
+ * Brought back season-episode information in the tvcom plugin (closes #15)
+ * Added the possibility to customize the output format (closes #16)
+ * Added a small FAQ
+ * Thanks to Majeed Goldrick for all the bug reports and feature suggestions
+ * Cosmetic changes
+
+== 0.2.3 (23 Jun 2005) ==
+ * The tvcom plugin now uses the new "All Seasons" link
+ * Cosmetic changes
+
+== 0.2.2 (17 Jun 2005) ==
+ * Added LICENSE file
+ * install.sh now correctly changes the EPISODER_HOME value
+ * Small fixes in the verbose output
+ * Created tvcom plugin
+ * Replaced all functionality from the tvtome plugin with a warning
+ * Now all the available modules are actually loaded
+ * Some minor changes in the man page
+
+== 0.2.1 (4 Jan 2005) ==
+ * The tvtome plugin now understands UNAIRED episodes
+ * Improved the builddb script's debug output
+ * Fixed an issue that would print errors for shows with no upcoming episodes
+ * The debian files are now part of the main distribution
+
+== 0.2.0 (13 Sep 2004) ==
+ * Initial public release

{episoder-0.10.1 → episoder-0.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: episoder
-Version: 0.10.1
+Version: 0.11.0
 Summary: TV episode notifier
 Home-page: https://code.ott.net/episoder/
 Author: Stefan Ott
@@ -17,6 +17,10 @@ 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>=1.3
 
 # episoder
 

{episoder-0.10.1 → episoder-0.11.0}/episoder/database.py

@@ -1,6 +1,6 @@
 # episoder, https://code.ott.net/episoder
 #
-# Copyright (C) 2004-2023 Stefan Ott. All rights reserved.
+# Copyright (C) 2004-2024 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
@@ -21,8 +21,7 @@ from datetime import datetime
 
 from sqlalchemy import Column, Integer, Text, Date, ForeignKey, Sequence
 from sqlalchemy import DateTime, Boolean
-from sqlalchemy.ext.declarative import declarative_base
-from sqlalchemy.orm import relationship, backref
+from sqlalchemy.orm import backref, declarative_base, relationship
 
 Base = declarative_base()
 
@@ -36,14 +35,14 @@ class Show(Base):
     __tablename__ = "shows"
 
     id = Column("show_id", Integer, Sequence("shows_show_id_seq"),
-                            primary_key=True)
+                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=u"", updated=datetime.fromtimestamp(0)):
+    def __init__(self, name, url="", updated=datetime.fromtimestamp(0)):
 
         self.name = name
         self.url = url
@@ -54,11 +53,11 @@ class Show(Base):
 
     def __str__(self):
 
-        return "Show: %s" % self.name
+        return f"Show: {self.name}"
 
     def __repr__(self):
 
-        return 'Show(u"%s", u"%s")' % (self.name, self.url)
+        return f'Show("{self.name}", "{self.url}")'
 
     def __eq__(self, other):
 
@@ -84,6 +83,7 @@ class Episode(Base):
     notified = Column(Date)
     show = relationship(Show, backref=backref("episodes", cascade="all"))
 
+    # pylint: disable=too-many-arguments
     def __init__(self, name, season, episode, aired, prodnum, total):
 
         self.title = name
@@ -96,26 +96,27 @@ class Episode(Base):
     def __lt__(self, other):
 
         return ((self.season < other.season)
-            or ((self.season == other.season)
-                and (self.episode < other.episode)))
+                or ((self.season == other.season)
+                    and (self.episode < other.episode)))
 
     def __str__(self):
 
-        return "%s %dx%02d: %s" % (self.show.name, self.season,
-            self.episode, self.title)
+        return f"{self.show.name} {self.season}x{self.episode:02d}: " \
+                f"{self.title}"
 
     def __repr__(self):
 
-        return 'Episode(u"%s", %d, %d, date(%d, %d, %d), u"%s", %d)' % (
-                self.title, self.season, self.episode,
-                self.airdate.year, self.airdate.month,
-                self.airdate.day, self.prodnum, self.totalnum)
+        d = self.airdate
+
+        return f'Episode("{self.title}", {self.season}, {self.episode}, ' \
+               f'date({d.year}, {d.month}, {d.day}), "{self.prodnum}", ' \
+               f'{self.totalnum})'
 
     def __eq__(self, other):
 
         return (self.show_id == other.show_id
-            and self.season == other.season
-            and self.episode == other.episode)
+                and self.season == other.season
+                and self.episode == other.episode)
 
 
 class Meta(Base):
@@ -126,7 +127,7 @@ class Meta(Base):
 
     def __str__(self):
 
-        return "Meta: %s = %s" % (self.key, self.value)
+        return f"Meta: {self.key} = {self.value}"
 
     def __repr__(self):
 

{episoder-0.10.1 → episoder-0.11.0}/episoder/episoder.py

@@ -1,6 +1,6 @@
 # episoder, https://code.ott.net/episoder
 #
-# Copyright (C) 2004-2023 Stefan Ott. All rights reserved.
+# Copyright (C) 2004-2024 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,8 +19,8 @@ import logging
 from datetime import date, timedelta
 
 import sqlite3
-from sqlalchemy import Table, MetaData, create_engine, or_, and_
-from sqlalchemy.orm import create_session
+from sqlalchemy import create_engine, or_, and_, select, inspect
+from sqlalchemy.orm import sessionmaker
 
 from .database import Episode, Show, Meta
 
@@ -37,20 +37,21 @@ class Database:
 
     def __str__(self):
 
-        return "Episoder Database at %s" % self._path
+        return f"Episoder Database at {self._path}"
 
     def __repr__(self):
 
-        return "Database(%s)" % self._path
+        return f"Database({self._path})"
 
     def _initdb(self):
 
+        inspector = inspect(self.engine)
+
         # Initialize the database if all tables are missing
-        tables = [Show, Episode, Meta]
-        tables = map(lambda x: x.__table__.exists, tables)
-        found = [x for x in tables if x(bind=self.engine)]
+        names = [Show, Episode, Meta]
+        tables = [t for t in names if inspector.has_table(t.__table__.name)]
 
-        if len(found) < 1:
+        if len(tables) < 1:
             Show.__table__.create(bind=self.engine)
             Episode.__table__.create(bind=self.engine)
             Meta.__table__.create(bind=self.engine)
@@ -61,36 +62,35 @@ class Database:
         if self._path.find("://") > -1:
             self.engine = create_engine(self._path)
         else:
-            self.engine = create_engine("sqlite:///%s" % self._path)
+            self.engine = create_engine(f"sqlite:///{self._path}")
 
-        self.conn = self.engine.connect()
-        self.metadata = MetaData()
-        self.metadata.bind = self.engine
-        self.session = create_session(bind=self.engine)
+        sm = sessionmaker(self.engine)
+        self.session = sm()
         self.session.begin()
 
     def close(self):
 
         self.session.commit()
         self.session.close()
-        self.conn.close()
         self.engine.dispose()
 
     def set_schema_version(self, version):
 
         meta = Meta()
         meta.key = "schema"
-        meta.value = "%d" % version
+        meta.value = f"{version}"
 
         with self.session.begin_nested():
             self.session.merge(meta)
 
     def get_schema_version(self):
 
-        if not Meta.__table__.exists(bind=self.engine):
+        inspector = inspect(self.engine)
+        if not inspector.has_table(Meta.__table__.name):
             return 1
 
-        res = self.session.query(Meta).get("schema")
+        res = self.session.scalars(
+                select(Meta).where(Meta.key == "schema")).first()
         if res:
             return int(res.value)
 
@@ -121,11 +121,10 @@ class Database:
             # simply drop and re-create the tables
             self.logger.debug("Upgrading to schema version 2")
 
-            table = Table("episodes", self.metadata, autoload=True)
-            table.drop()
-
-            table = Table("shows", self.metadata, autoload=True)
-            table.drop()
+            upgrade = sqlite3.connect(self._path)
+            upgrade.execute("DROP TABLE episodes")
+            upgrade.execute("DROP TABLE shows")
+            upgrade.close()
 
             Show.__table__.create(bind=self.engine)
             Episode.__table__.create(bind=self.engine)
@@ -146,9 +145,9 @@ class Database:
 
             upgrade = sqlite3.connect(self._path)
             upgrade.execute("ALTER TABLE shows "
-                    "ADD COLUMN enabled TYPE boolean")
+                            "ADD COLUMN enabled TYPE boolean")
             upgrade.execute("ALTER TABLE shows "
-                    "ADD COLUMN status TYPE integer")
+                            "ADD COLUMN status TYPE integer")
             upgrade.close()
 
             self.open()
@@ -167,7 +166,7 @@ class Database:
 
             upgrade = sqlite3.connect(self._path)
             upgrade.execute("ALTER TABLE episodes "
-                    "ADD COLUMN notified TYPE date")
+                            "ADD COLUMN notified TYPE date")
             upgrade.close()
 
             self.open()
@@ -216,7 +215,8 @@ class Database:
 
     def get_show_by_id(self, show_id):
 
-        return self.session.query(Show).get(show_id)
+        return self.session.scalars(
+                select(Show).where(Show.id == show_id)).first()
 
     def add_show(self, show):
 
@@ -226,15 +226,17 @@ class Database:
 
     def remove_show(self, show_id):
 
-        show = self.session.query(Show).get(show_id)
+        show = self.session.scalars(
+                select(Show).where(Show.id == show_id)).first()
 
         if not show:
             self.logger.error("No such show")
             return
 
-        episodes = self.session.query(Episode)
+        episodes = self.session.scalars(select(Episode))
 
-        for episode in episodes.filter(Episode.show_id == show.id):
+        hits = [e for e in episodes if e.show_id == show.id]
+        for episode in hits:
             self.session.delete(episode)
 
         self.session.delete(show)
@@ -254,18 +256,18 @@ class Database:
 
         enddate = basedate + timedelta(n_days)
 
-        return self.session.query(Episode).\
+        return self.session.query(Episode). \
             filter(Episode.airdate >= basedate). \
             filter(Episode.airdate <= enddate). \
             order_by(Episode.airdate).all()
 
     def search(self, search):
 
-        return self.session.query(Episode).\
-            filter(or_( \
-                Episode.title.like("%%%s%%" % search),
-                Show.name.like("%%%s%%" % search))). \
-            order_by(Episode.airdate).all()
+        q = self.session.query(Episode).join(Episode.show)
+        return q.filter(or_(
+                Episode.title.like(f"%%{search}%%"),
+                Show.name.like(f"%%{search}%%"))). \
+            order_by(Episode.airdate.asc()).all()
 
     def commit(self):