Updated README with systemd instructions.

Author: malahal

MANIFEST.in

@@ -5,38 +5,58 @@ HDHOMERUN recorder
 Description:
 ============
     A python program to record TV programs using hdhomerun tuner device.
-    This should run on any system capable of running python. In other
-    words, no other dependencies other than python and apscheduler
-    python module.
+    This should run on any system capable of running python and
+    hdhomerun_config binary program.
 
     The hdhomerun tuner doesn't need much processing power for recording
-    a program. So this is mainly intended for embedded systems. I use it
-    on my WDTV Live media player.
+    a program. So this is mainly intended for embedded systems. I used it
+    on my WDTV Live media player. Now I use it on my pogoplug running
+    arch Linux.
 
 INSTALL:
 ========
     1. Install python if you don't have it already
     2. Install apscheduler from here. The old version of apscheduler has
         some issues, so be sure to install the latest V2 version.
         (https://bitbucket.org/agronholm/apscheduler)
-    3. Copy three files from this project to some place on your system
-       1. recorder.py: The main python program
-       2. config-file: My config file, replace at least the tuners and
-       		channelmap section with your tuner id and local channels.
-       3. schedule-file: This is an example schedule file. Modify entries
-                         with programs you like to record.
-    4. Copy hdhomerun_config binary to the directory that contains above
-       files
-    5. Run ./recorder.py and watch ./logfile for log output.
-
-WDTV Live player:
-=================
-    I use wdlxtv firmware (third party firmware, http://wiki.wdlxtv.com)
-    on my WDTV Live media player.  Since it does not come with python, I use
-    optware bin and installed python using ipkg. Thanks to b-rad!
-
-    Link to Optware for WDLXTV Live media player:
-    http://b-rad.cc/optware-for-wdtv/
-
-    Link to the actual opt.bin (be sure to install python using ipkg):
-    http://b-rad.cc/binaries/opt.bin.tgz
+    3. Install this package.
+       If you have "pip", do "pip install hdhomerun-recorder"
+       			OR
+       If you have "easy_install". do "easy_install install hdhomerun-recorder"
+       			OR
+       You can manually download the source from PyPI
+       (https://pypi.python.org/pypi/hdhomerun-recorder), extract and
+       then install it using: "python setup.cfg install"
+
+    4. Create config-file
+       a) Run /usr/bin/hdhomerun_recorder_setup /etc/hdhomerun_recorder/config-file
+	  This will ask few question and write your tuner and channel
+	  mappings into /etc/hdhomerun_recorder/config-file file. This
+	  will take some time as it scans your local channels
+
+	  See /etc/hdhomerun_recorder/config-file.example to see how an
+	  example config file looks like. You may need to create one by
+	  hand if the above script fails to create one for any reason!
+    5. Edit schedule file
+       See /etc/hdhomerun_recorder/schedule-file.example for details.
+       You have given schedule-file location in the config-file. Edit
+       that file with what and when you want to record etc.
+    6. Run /usr/bin/hdhomerun_recorder /etc/hdhomerun_recorder/config-file
+
+    7. Optional: See the logfile for information or errors.
+    8. Optional. I have included /etc/hdhomerun_recorder/hdhomerun_recorder.service
+       file that can be used to automatically start the recording daemon
+       on reboot.  You can stop, start and reload the daemon. The
+       "reload" option is useful when you update schedule file and you
+       want the daemon to use the changes. Of course, this only works if
+       you have systemd based start up (latest Ubuntu, Fedora, Arch
+       distros will have)!
+
+       a) Install service
+          cp /etc/hdhomerun_recorder/hdhomerun_recorder.service /etc/systemd/system/
+       b) Enable the service
+          systemctl enable hdhomerun_recorder.service
+       c) Start the service now
+          systemctl start hdhomerun_recorder.service
+
+       Run "systemctl reload hdhomerun_recorder.service" whenever you change your schedule-file!

README

@@ -0,0 +1,11 @@
+[Unit]
+Description=Hdhomerun tuner recording service
+After=openntpd.service
+
+[Service]
+Type=simple
+ExecStart=/usr/bin/hdhomerun_recorder /etc/hdhomerun_recorder/config-file
+ExecReload=/bin/kill -HUP $MAINPID
+
+[Install]
+WantedBy=multi-user.target

TODO

@@ -1,6 +1,6 @@
 #!/usr/bin/env python
 
-import os, os.path
+import sys, os, os.path
 import subprocess
 import signal, datetime
 import logging
@@ -9,6 +9,9 @@
 def main():
     from apscheduler.scheduler import Scheduler
 
+    if len(sys.argv) != 2:
+        sys.exit("usage: %s <config-file>" % sys.argv[0])
+
     try:
         from ConfigParser import ConfigParser
     except ImportError: # python3
@@ -19,7 +22,7 @@ def main():
     except TypeError: # not python3
         config = ConfigParser()
 
-    config.readfp(open('config-file'))
+    config.readfp(open(sys.argv[1]))
     global logfile
     logfile = config.get("global", "logfile")
     FORMAT = "%(asctime)-15s: %(message)s"
@@ -49,20 +52,31 @@ def main():
         channelmap[opt] = config.get("channelmap", opt).split(",")
 
     while True:
-        global reload_jobs
+        global reload_jobs, shutdown
         reload_jobs = False
+        shutdown = False
         sched = Scheduler(misfire_grace_time=60, daemonic=False)
         sched.start()
         signal.signal(signal.SIGHUP, sighup_handler)
+        signal.signal(signal.SIGTERM, sigterm_handler)
         schedule_jobs(sched, schedule_file, channelmap, media_dir)
-        while not reload_jobs:
+        while not (reload_jobs or shutdown):
             signal.pause()
         sched.shutdown()
+        if shutdown:
+            sys.exit(0)
 
 def sighup_handler(signum, frame):
     global reload_jobs
+    logging.info("Received SIGHUP, reloading schedule-file")
     reload_jobs = True
 
+def sigterm_handler(signum, frame):
+    # TODO: Kill any recorder threads?
+    logging.info("Received SIGTERM, shutting down")
+    global shutdown
+    shutdown = True
+
 def schedule_jobs(sched, schedule_file, channelmap, media_dir):
     import shlex
     for line in open(schedule_file):

config-file data/config-file.example

@@ -1,3 +1,5 @@
 #!/usr/bin/env python
 
-pass
+import hdhomerun_recorder.setup
+
+hdhomerun_recorder.setup.main()

data/hdhomerun_recorder.service

@@ -5,11 +5,14 @@
     version='0.1.0',
     author='Malahal Naineni',
     author_email='[email protected]',
-    py_modules=['hdhomerun_recorder'],
-    scripts=['scripts/hdhomerun_recorder', 'scripts/hdhomerun_recorder_setup'],
-    url='http://pypi.python.org/pypi/hdhomerun-recorder/',
     description='hdhomerun network tuner recorder',
     long_description=open('README').read(),
-    #zip_safe=False,
-    #package_data={'hdhomerun.recorder': ['config-file-example']},
+    url='http://pypi.python.org/pypi/hdhomerun-recorder/',
+
+    requires=["apscheduler"],
+    packages=['hdhomerun_recorder'],
+    scripts=['scripts/hdhomerun_recorder', 'scripts/hdhomerun_recorder_setup'],
+    data_files = [('/etc/hdhomerun_recorder',
+                    ['data/config-file.example', 'data/schedule-file.example',
+                        'data/hdhomerun_recorder.service'])]
 )