Send a personal briefing email daily from a 24/7 Linux server. Collect repetitive checklists and see them in a single HTML email message.
Currently, the email contents are created from National Weather Service, NewsAPI and Google Calendar events.
Prerequisites: git, bash, python3, pip3, external API keys
Download the repo.
git clone https://github.com/bebaek/briefer.git
In the cloned directory, run the CLI installation script. This installs this
package with pip3, creates a configuration file, and registers to the users
crontab. (Run crontab -e to further modify your crontab.) This can also be
used to upgrade/reinstall the package. Cancel configuring steps by pressing
ctrl-c if a package upgrade is all that is needed.
bash install.sh
The required cryptography package may not be installed at first on certain
platforms (e.g. 32-bit Linux). See
Cryptography for further
details.
See the usage of the main command:
briefer -h
(Re-)configure:
briefer config
Check the HTML content composition:
briefer html
Test-send an email:
briefer send
Uninstall the Python package:
pip uninstall briefer
Remove the config directory:
rm -rf ~/.config/briefer
Set up the sender email account for SMTP use. Of course, have a receiver email account too.
Get a NewsAPI key from NewsAPI.
(To be expanded.)
Get a Google Calendar account and authorize this app for the API access. Refer
to reference 1 and
reference 2.
Set the scope to https://www.googleapis.com/auth/calendar.readonly.
First, collect a bunch of keys: client_id, client_secret, device code.
Then get refresh_token.
Prerequisites: git, bash, edm
Download repo.
git clone https://github.com/bebaek/briefer.git
Run setup script.
bash ci/setup-devenv.sh
Prerequisites: sender/receiver email accounts for SMTP use, API key from NewsAPI, Google Calendar account and API access
Activate the dev environment:
edm shell -e briefer
Check the usage and also if it runs:
briefer -h