https://github.com/vmapps/feed2mail
News feeds sent to your mailbox
https://github.com/vmapps/feed2mail
email feedparser jinja2 news smtplib templates
Last synced: 6 months ago
JSON representation
News feeds sent to your mailbox
- Host: GitHub
- URL: https://github.com/vmapps/feed2mail
- Owner: vmapps
- Created: 2019-05-14T20:15:40.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-04-18T10:36:46.000Z (over 4 years ago)
- Last Synced: 2024-03-31T23:23:04.351Z (over 1 year ago)
- Topics: email, feedparser, jinja2, news, smtplib, templates
- Language: Python
- Homepage:
- Size: 649 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# feed2mail
News feeds sent to your mailbox
## Purpose
Purpose of this very simple tool is to :
- help retrieving news from different feeds (RSS, ATOM, XML, ...)
- compile one of those that match a pediod (e.g. 'yesterday')
- send articles as HTML document to some email recipients
## Requirements
Following python modules are required :
- [email](https://docs.python.org/3/library/email.html)
- [feedparser](https://pythonhosted.org/feedparser/)
- [jinja2](http://jinja.pocoo.org/)
- [smtplib](https://docs.python.org/3/library/smtplib.html)
Modules could be installed using following commands:
```
$ pip install -r requirements.txt
```
## Configuration
Settings have to be defined using JSON config file :
```
# enable/disable debug mode
"debug": [true|false]
# SMTP settings
"smtp.host": ""
"smtp.port": 465
"smtp.ssl": [true|false]
"smtp.user": ""
"smtp.pass": ""
# feeds sources and period of posts to take into consideration
"feeds.sources": [
'http://feeds.arstechnica.com/arstechnica/security/',
'https://nakedsecurity.sophos.com/feed/',
'https://www.theregister.co.uk/security/headlines.atom'
]
"feeds.period": "[all|yesterday|today]"
# email settings
"email.sender": ""
"email.recipient": ""
"email.title": ""
```
Do not forget to rename template file as `config.json`
```
mv config-template.json config.json
```
## Usage
```
usage: feed2mail.py [-h] [-a] [-d] [-c ] [-o ] [-t ]
optional arguments:
-h, --help show this help message and exit
-a, --attachment add HTML content as attachment
-d, --debug force debug mode (not used yet)
-c , --config
config file name (defaut: config.json)
-t , --template
template file name (defaut: templates/feed2mail.html)
-o , --output
output file name
```
## Outputs
```
$ feed2mail.py
[INFO] message successfully sent to *****@*****.***
$ feed2mail.py -c feed2mail.json -t templates/feed2mail-outlook.html -o /tmp/output.html
[INFO] message successfully sent to *****@*****.***
```
Once executed, the program will generate :
- HTML code in email body
- HTML file attached to the email
- HTML code to if output option is used
- success/error messages to stderr
## Sample
