episoder 0.11.1__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-1.0.0/episoder/config.py

@@ -0,0 +1,102 @@
+# 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/>.
+
+from logging import getLogger
+from os import environ, path
+
+from typing import BinaryIO, Optional
+
+from .version import __version__
+
+
+class InvalidDataFormatError(Exception):
+    def __init__(self, filename: str) -> None:
+        super().__init__(f'Please remove old/invalid data file: {filename}')
+
+
+class EpisoderConfig:
+    # pylint: disable=too-few-public-methods,too-many-instance-attributes
+    def __init__(self) -> None:
+        self.agent = f'episoder/{__version__}'
+        self.datafile = path.join(environ['HOME'], '.episodes')
+        self.dateformat = '%a, %b %d, %Y'
+        self.format = '%airdate %show %seasonx%epnum'
+        self.tvdb_key = '8F15287C4B23B36E'
+
+        self.email_to: Optional[str] = None
+        self.email_username: Optional[str] = None
+        self.email_password: Optional[str] = None
+        self.email_server = 'localhost'
+        self.email_port = 587
+        self.email_tls = False
+
+
+class ConfigLoader:
+    def __init__(self) -> None:
+        self._log = getLogger('Config')
+
+    def _load_rcfile(self, file_: BinaryIO) -> dict[str, str]:
+        def strip_comments(line: str) -> str:
+            return line.split('#')[0]
+
+        def valid(line: str) -> bool:
+            return '=' in line
+
+        self._log.info('Loading config file')
+        lines = file_.readlines()
+        decoded_lines = [x.decode('utf8').strip() for x in lines]
+        non_comments = map(strip_comments, decoded_lines)
+        valid_lines = filter(valid, non_comments)
+        return dict(line.split('=') for line in valid_lines)
+
+    def _update(self, cfg: EpisoderConfig, values: dict[str, str]) -> None:
+        cfg.agent = values.get('agent', cfg.agent)
+        cfg.datafile = values.get('data', cfg.datafile)
+        cfg.dateformat = values.get('dateformat', cfg.dateformat)
+        cfg.format = values.get('format', cfg.format)
+        cfg.tvdb_key = values.get('tvdb_key', cfg.tvdb_key)
+
+        cfg.email_to = values.get('email_to', cfg.email_to)
+        cfg.email_username = values.get('email_username', cfg.email_username)
+        cfg.email_password = values.get('email_password', cfg.email_password)
+        cfg.email_port = int(values.get('email_port', cfg.email_port))
+        cfg.email_server = values.get('email_server', cfg.email_server)
+        cfg.email_tls = bool(values.get('email_tls', cfg.email_tls))
+
+    def load(self, file: str) -> EpisoderConfig:
+        config = EpisoderConfig()
+
+        if path.exists(file):
+            with open(file, 'rb') as file_:
+                values = self._load_rcfile(file_)
+
+            self._log.debug('Settings loaded: %s', values)
+            self._update(config, values)
+            self._log.info("Loaded configuration")
+        else:
+            self._log.warning('No config file found, using defaults')
+
+        return config
+
+    def validate(self, config: EpisoderConfig) -> None:
+        filename = config.datafile
+        if path.exists(filename):
+            with open(filename, 'rb') as file:
+                data = file.read(6)
+
+            if data != b'SQLite':
+                raise InvalidDataFormatError(filename)

episoder-1.0.0/episoder/database.py

@@ -0,0 +1,132 @@
+# 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/>.
+
+from datetime import date, datetime
+from typing import Any, Optional
+
+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
+
+
+# pylint: disable=too-few-public-methods
+class Base(DeclarativeBase):
+    pass
+
+
+class Show(Base):
+    RUNNING = 1
+    SUSPENDED = 2
+    ENDED = 3
+
+    __tablename__ = "shows"
+
+    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: list[Episode] = []
+        self.enabled = True
+
+    def __str__(self) -> str:
+        return f"Show: {self.name}"
+
+    def __repr__(self) -> str:
+        return f'Show("{self.name}", "{self.url}")'
+
+    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 = 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: 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)
+        self.airdate = aired
+        self.prodnum = prodnum
+        self.totalnum = int(total)
+
+    def __str__(self) -> str:
+        return f"{self.show.name} {self.season}x{self.episode:02d}: " \
+                f"{self.title}"
+
+    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 __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
+                and self.episode == other.episode)
+
+
+class Meta(Base):
+    __tablename__ = "meta"
+    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) -> str:
+        return str(self)