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)
