2023-06-11 04:11:13 +00:00
# intake-sources
This repo contains programs that act as `intake` feed sources.
2023-06-20 18:46:41 +00:00
The provided NixOS module adds the default overlay to `nixpkgs` , providing each feed source program individually as well as the `intakeSources` package that provides all of them together.
2023-06-11 04:11:13 +00:00
## intake-rss
A feed source that wraps an RSS or Atom feed.
Supported `env` :
- `FEED_URL` : Required. The url of the RSS/Atom feed.
- `FEED_TITLE` : Override the feed `<title>` . Item titles are in the format "[feed title]: [item title]".
2023-06-12 03:31:48 +00:00
## intake-reddit
A feed source that fetches posts from a subreddit.
Supported `env` :
- `SUBREDDIT_NAME` : Required. The subreddit name with no `r/` prefix.
- `SUBREDDIT_PAGE` : The listing page to fetch posts from. Defaults to `hot` . Listings that support multiple time ranges can specify as e.g. `top_week` .
- `REQUEST_RETRY` : Attempt count for fetching posts. Retries are done with exponential backoff.
- `FILTER_NSFW` : By default, NSFW posts are included. Set to a truthy value to skip them.
- `TAG_NSFW` : By default, NSFW posts are tagged `nsfw` . Set to an empty string to suppress this.
- `FILTER_SPOILER` : As `FILTER_NSFW` for posts marked as spoilers.
- `TAG_SPOILER` : As `TAG_NSFW` for posts marked as spoilers.
- `MIN_SCORE` : Skip posts with scores below this number.
- `TAGS` : Comma-separated list of tags to add to all items.
- `AUTHOR_BLOCKLIST` : Comma-separated list of usernames. Posts by these users will be skipped.
2023-06-24 13:53:41 +00:00
- `NO_VIDEO` : Set to a truthy value to filter out v.redd.it links.
2023-06-12 03:56:51 +00:00
## intake-hackernews
A feed source that returns stories from [Hacker News ](https://news.ycombinator.com/ ).
Supported `env` :
- `FETCH_COUNT` : Number of posts to fetch from the front page. Default 30.
- `REQUEST_RETRY` : Attempt count for fetching posts. Retries are done with exponential backoff.
- `MIN_SCORE` : Skip stories with scores below this number.
2023-06-25 04:45:23 +00:00
## intake-echo
A feed source that echoes a message. This is useful with `cron` support to create recurring reminders.
Supported `env` :
- `TITLE` : The title of the item.
- `BODY` : The body of the item.
- `UNIQUE` : If set to a truthy value, the item id will be the hash of the title, so the same item will be generated until the message is changed.
2023-07-03 01:10:46 +00:00
## intake-praw
Like `intake-reddit` , but uses [PRAW ](https://praw.readthedocs.io/en/stable/ ) to access Reddit instead of just hitting the public JSON API directly.
Supported `env` :
- `CLIENT_ID` : Required. `client_id` for PRAW.
- `CLIENT_SECRET` : Required. `client_secret` for PRAW.
- `USER_AGENT` : User agent for PRAW. By default, `nixos:intake_praw:X.Y.Z` with the current version number.
- `SUBREDDIT_NAME` : Required. The subreddit name with no `r/` prefix.
- `SUBREDDIT_PAGE` : The listing page to fetch posts from. Defaults to `hot` . Listings that support multiple time ranges can specify as e.g. `top_week` .
- `POST_LIMIT` : The number of posts to fetch. Default `25` .
- `FILTER_NSFW` : By default, NSFW posts are included. Set to a truthy value to skip them.
- `FILTER_SPOILER` : As `FILTER_NSFW` for posts marked as spoilers.
- `MIN_SCORE` : Skip posts with scores below this number.
- `TAGS` : Comma-separated list of tags to add to all items.
- `NO_VIDEO` : Set to a truthy value to filter out `v.redd.it` links.
