Feeds to Pocket
Feeds to Pocket watches your RSS and Atom feeds and pushes new items to your Pocket list.
License
Feeds to Pocket is licensed under the terms of either the MIT license or the Apache License, version 2.0, at your option. Feeds to Pocket also uses third party libraries, some of which have different licenses.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Prerequisites
Feeds to Pocket uses OpenSSL for HTTPS requests. If you don't have OpenSSL, you'll have to install it first.
You'll need Cargo, Rust's package manager. If you don't already have it, go to the Rust home page, then download and install Rust for your platform, which will install the Rust compiler and Cargo.
Usage
Installation
In a terminal or command prompt, run the following command:
$ cargo install feeds-to-pocket
This will install the last version of Feeds to Pocket that was published to crates.io.
If you want to install an update, run:
$ cargo install --force feeds-to-pocket
Configuration
Feeds to Pocket uses a file to store your configuration (list of feeds to monitor, Pocket access credentials). You must specify a file name as a command-line argument when you call the program; there's no default file name.
First, you must create your configuration file:
$ feeds-to-pocket ~/feeds-to-pocket.yaml init
~/feeds-to-pocket.yamlis just an example, you can use any file name you want!
Then, you must create an application on the developer section of Pocket's website. Make sure you select at least the Add permission. This will give you a consumer key, which is necessary to use Pocket's API. Customer keys have rate limits, so I suggest you keep your consumer key private.
When you've obtained your consumer key, save it in your configuration file:
$ feeds-to-pocket ~/feeds-to-pocket.yaml set-consumer-key 1234-abcd1234abcd1234abcd1234
After that, you need to login. Just run:
$ feeds-to-pocket ~/feeds-to-pocket.yaml login
and follow the instructions. This will save an access token in your configuration file. The access token acts like your account's password, so keep it safe!
Congratulations, Feeds to Pocket is now ready to talk to Pocket!
Adding feeds
Once the above configuration steps are done,
you're ready to add feeds.
Use the add subcommand to add a feed:
$ feeds-to-pocket ~/feeds-to-pocket.yaml add https://xkcd.com/atom.xml
This will download the feed
and mark all current entries as "processed"
without sending them to Pocket.
If you would like all current entries to be sent to Pocket,
pass the --unread flag:
$ feeds-to-pocket ~/feeds-to-pocket.yaml add --unread https://xkcd.com/atom.xml
Repeat this for every feed you'd like Feeds to Pocket to monitor.
Sending new entries to Pocket
Call feeds-to-pocket without a subcommand
to have it download your feeds
and send new entries to Pocket.
$ feeds-to-pocket ~/feeds-to-pocket.yaml
Once an entry has been sent to Pocket, Feeds to Pocket marks it as "processed" and will not send it again.
Assigning tags to feeds
You can assign tags to feeds. When a new entry is pushed to Pocket, it will be assigned the tags that were set on the feed the entry comes from.
To do this, pass the --tags option
to the add subcommand.
You can do this while adding a new feed
or for an existing feed
(then it will replace the list of tags for that feed).
The --tags option is followed by a comma-separated list of tags.
$ feeds-to-pocket ~/feeds-to-pocket.yaml add --tags comics,xkcd https://xkcd.com/atom.xml
Scheduling
Feeds to Pocket doesn't have any built-in scheduling mechanisms.
You should use an existing task scheduler
to run the feeds-to-pocket program periodically.
If you are using Linux with systemd,
you can set up a systemd timer
for your systemd user instance.
See the example unit files in the systemd-examples directory.
Removing feeds
Use the remove subcommand to remove a feed:
$ feeds-to-pocket ~/feeds-to-pocket.yaml remove https://xkcd.com/atom.xml
Compiling from source
To build the project, just run:
$ cargo build
from the project's directory. This will download and compile all of the project's Rust dependencies automatically.
Issues
If you find a bug, first check if you're using the latest version, and update if that's not the case. If the bug still occurs, please check if there's already a similar issue (check both open and closed issues!). If there isn't, then file a new issue. If the program outputs an error message, please include it in your issue. Also mention what operating system you're using and which version.
Contributing
See CONTRIBUTING.