Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eduardostuart/paperboy
🗞 Paperboy is a CLI tool that delivers new posts from your favorite sites by email.
https://github.com/eduardostuart/paperboy
cli email feed rss rss-feed rust smtp
Last synced: 9 days ago
JSON representation
🗞 Paperboy is a CLI tool that delivers new posts from your favorite sites by email.
- Host: GitHub
- URL: https://github.com/eduardostuart/paperboy
- Owner: eduardostuart
- License: mit
- Created: 2021-11-16T20:46:22.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-27T12:03:23.000Z (12 months ago)
- Last Synced: 2023-11-28T12:25:26.802Z (12 months ago)
- Topics: cli, email, feed, rss, rss-feed, rust, smtp
- Language: Rust
- Homepage:
- Size: 1.66 MB
- Stars: 15
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT
Awesome Lists containing this project
README
# Paperboy
[](https://github.com/eduardostuart/paperboy/actions/workflows/ci.yml)
Paperboy is a CLI tool that delivers new posts from your favorite sites by email.
## Installation
**From binaries**
Check out the [release page](https://github.com/eduardostuart/paperboy/releases/) for prebuilt versions of `Paperboy`.
## Usage
Set these environment variable values:
```bash
SMTP_HOST="smtp.mailtrap.io" # SMTP host
SMTP_PORT=2525 # SMTP port
SMTP_USERNAME="username" # SMTP username
SMTP_PASSWORD="password" # SMTP password
SMTP_FROM="Paperboy " # the sender
MAIL_TO="[email protected]" # the recipient
EMAIL_SUBJECT="Subject" # Email subject (optional)
```
```sh
Paperboy CLI
Usage: paperboy [OPTIONS]
Commands:
deliver Deliver new posts from sites by email
help Print this message or the help of the given subcommand(s)
Options:
-v, --verbose... More output per occurrence
-q, --quiet... Less output per occurrence
-h, --help Print help
-V, --version Print version
```
### Deliver command
```bash
paperboy deliver email@domain subscriptions.txt template.hbs template_text.hbs
# Template example.: emails/daily_email.hbs
```
## GitHub template
If you want an **automatic** and **free** way to receive daily "newspapers" using `paperboy`, take a look at the [paperboy-template](https://github.com/eduardostuart/paperboy-template) GitHub project.
## Tests
```
cargo test
```
## License
This code is distributed under the terms of MIT license.
See [LICENSE-MIT](LICENSE-MIT) for details.
[Image](.github/resources/paperboy.png) generated by DALL-E OpenAI.