Python script to create newsletter of what's new in calibre-web
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
cps-whatsnew
custom
logs
.gitattributes
readme.md
requirements.txt
setup.py

readme.md

cps-WhatsNew

Background

I totally love calibre-web as an interface to my calibre collection. One feature I thought the system could use is a notification or newsletter that would inform site users know what books have been uploaded. In addition, I wanted a project to sink my teeth into with some Python.

The result is this project. Originally I thought it would be nice just to have a newsletter feature, but now I'm thinking of ways to improve the code. So for the foreseeable future, I'll be updating this repo a little more frequently. Additions will be tracked in other git branches.

General Info

Basic python v2 script that will read the OPDS feed of a calibre-web site (or any other opds feed for that matter - never tested it, but it should work), scan for new books uploaded in a given time frame, then send an email out to a set of interested folks.

Configuration files

There are two configuration files in the project - one for logging and the other for the project itself. Coming from a big corporate environment, logging is something I don't see a lot of and I wanted to make it a point of including it right from the beginning as opposed to something that is baked in afterwards.

The other configuration file is a standard JSON formatted configuration file. The program is so small and its relatively obvious what its supposed to be doing that I don't think its really all that important to write up documentation on each setting. However, if you have a question, just ask.

Added a DevMode option in the configuration file. Basically a true/false setting. A true will prevent the tool from sending emails out to everyone.

Email Template

The email template is a little.... complicated. I used BeeFree.io to create it. Great service - but, MAN!, the resulting HTML is pretty involved!

In any event, I'm embedding a banner image for the email template. You can find the location in the config file. If your email does not have a banner - remove the appropriate line in the code.

Log File

Like I mentioned previously, I put logging into the script (and maybe a little too much.) I've used the inherent python logging libraries and you can see the settings in the appropriate logging configuration file. Initially, I set it up for circular logging to save on disk space. More for my own sanity than anything else.

Thumbnails

I was able add book thumbnails to the outgoing email. Unfortunately, I needed the ability to write the thumbnail to disk before embedding it into the email. I'm sure I don't HAVE to do this, but after awhile it was just easier. Thus, as a requirement, whatever user you use to run this script, they must have write access to the directory.

Distribution List management

I originally kept the distribution list in the configuration file, however, after thinking about it for a bit, I decided to go ahead and attempt to add a database query to this script.

A new configuration item,DLSource, in the config file tells the script to either pull the dl members from the configuration file or attempt the db method. "config" or "db" should be allowed entries.

Also added a DistributionExclusionsList section to the configuration file. This can be used to eliminate anyone who doesn't want the email. Note - no@email is a needed value here.

Docker Image

If you'd like to implement this via Docker, go here: https://github.com/bodybybuddha/docker-cpswhatsnew

Future Features

None planned.