From b169c5c2b3c782cd6f620a975071834902cb362a Mon Sep 17 00:00:00 2001 From: jem Date: Mon, 8 Jun 2020 20:44:25 +0200 Subject: [PATCH] reviewed & updated doc --- README.md | 8 ++-- test.edn | 125 ++++++++++++++++++++++++++++-------------------------- 2 files changed, 68 insertions(+), 65 deletions(-) diff --git a/README.md b/README.md index 4bb9918..6300178 100644 --- a/README.md +++ b/README.md @@ -51,7 +51,7 @@ with later timestamps to avoid duplicate posts. On the first run the timestamp w :nitter-urls? false ;; accounts you wish to mirror :accounts ["arstechnica" "WIRED"]} - :target {:target-type :mastodon-target + :target {:target-type :mastodon ;; optional flag specifying wether the name of the account ;; will be appended in the post, defaults to false :append-screen-name? false @@ -83,7 +83,7 @@ with later timestamps to avoid duplicate posts. On the first run the timestamp w ;; add RSS config to follow feeds :feeds [["Hacker News" "https://hnrss.org/newest"] ["r/Clojure" "https://www.reddit.com/r/clojure/.rss"]]} - :target {:target-type :mastodon-target + :target {:target-type :mastodon ...} :resolve-urls? ...} @@ -91,9 +91,9 @@ with later timestamps to avoid duplicate posts. On the first run the timestamp w ;; optional limit for number of posts to retrieve, default: 5 :limit 10 :accounts ["cyberpunky.tumblr.com" "scipunk.tumblr.com"] - :target {:target-type :mastodon-target + :target {:target-type :mastodon ...} - :resolve-urls? ...} + :resolve-urls? ...}} ] } ``` diff --git a/test.edn b/test.edn index 1bf349b..75241e9 100644 --- a/test.edn +++ b/test.edn @@ -1,69 +1,72 @@ -{;; add Twitter config to mirror Twitter accounts - :twitter {:access-keys - {:consumer_key "XXXX" - :consumer_secret "XXXX" - :access_token_key "XXXX" - :access_token_secret "XXXX"} - ;; optional, defaults to false - :include-replies? false - ;; optional, defaults to false - :include-rts? false - ;; accounts you wish to mirror - :accounts ["arstechnica" "WIRED"]} - ;; add Tumblr config to mirror Tumblr accounts - :tumblr {:access-keys - {:consumer_key "XXXX" - :consumer_secret "XXXX" - :token "XXXX" - :token_secret "XXXX"} - ;; optional limit for number of posts to retrieve, default: 5 - :limit 10 - :accounts ["cyberpunky.tumblr.com" "scipunk.tumblr.com"]} - ;; add RSS config to follow feeds - :rss {"Hacker News" "https://hnrss.org/newest" - "r/Clojure" "https://www.reddit.com/r/clojure/.rss"} - :mastodon {:access_token "XXXX" - ;; account number you see when you log in and go to your profile - ;; e.g: https://mastodon.social/web/accounts/294795 - :account-id "XXXX" - :api_url "https://botsin.space/api/v1/" +{:auth {;; add Twitter config to mirror Twitter accounts + :twitter {:consumer_key "XXXX" + :consumer_secret "XXXX" + :access_token_key "XXXX" + :access_token_secret "XXXX"} + :mastodon {:access_token "XXXX" + ;; account number you see when you log in and go to your profile + ;; e.g: https://mastodon.social/web/accounts/294795 + :account-id "XXXX" + :api_url "https://botsin.space/api/v1/"} + :tumblr {:consumer_key "XXXX" + :consumer_secret "XXXX" + :token "XXXX" + :token_secret "XXXX"}} + :transform + [{:source {:source-type :twitter + ;; optional, defaults to false + :include-replies? false + ;; optional, defaults to false + :include-rts? false + ;; Replace Twitter links by Nitter + :nitter-urls? false + ;; accounts you wish to mirror + :accounts ["arstechnica" "WIRED"]} + :target {:target-type :mastodon + ;; optional flag specifying wether the name of the account + ;; will be appended in the post, defaults to false + :append-screen-name? false + ;; optional visibility flag: direct, private, unlisted, public + ;; defaults to public + :visibility "unlisted" ;; optional boolean to mark content as sensitive :sensitive? true ;; optional boolean defaults to false ;; only sources containing media will be posted when set to true :media-only? true - ;; optional visibility flag: direct, private, unlisted, public - ;; defaults to public - :visibility "unlisted" ;; optional limit for the post length :max-post-length 300 - ;; optional flag specifying wether the name of the account - ;; will be appended in the post, defaults to false - :append-screen-name? false ;; optional signature for posts - :signature "#newsbot" - ;; optionally try to resolve URLs in posts to skip URL shorteners - ;; defaults to false - :resolve-urls? true - ;; optional content filter regexes - ;; any posts matching the regexes will be filtered out - :content-filters [".*bannedsite.*"] - ;; optional keyword filter regexes - ;; any posts not matching the regexes will be filtered out - :keyword-filters [".*clojure.*"] - ;; optional replacements - :replacements {"@openSUSE " "@opensuse@fosstodon.org ", - "@archlinux " "", - "@lolamby " "", - "@conservancy " "@conservancy@mastodon.technology ", - "@prototypefund " "@PrototypeFund@mastodon.social ", - "@coreboot_org " "", - "@OpenTechFund " "", - "@OpenWrtSummit " "", - "@OpenMirage " "", - "@debian " "@debian@fosstodon.org ", - "@nixos_org " "", - "@lwnnet " "", - "@guixhpc" ""} - ;; Replace Twitter links by Nitter - :nitter-urls? false}} + :signature "#newsbot"} + ;; optionally try to resolve URLs in posts to skip URL shorteners + ;; defaults to false + :resolve-urls? true + ;; optional content filter regexes + ;; any posts matching the regexes will be filtered out + :content-filters [".*bannedsite.*"] + ;; optional keyword filter regexes + ;; any posts not matching the regexes will be filtered out + :keyword-filters [".*clojure.*"] + ;; TODO: Description & example missing here + :replacements nil} + + {:source {:source-type :rss + ;; add RSS config to follow feeds + :feeds [["Hacker News" "https://hnrss.org/newest"] + ["r/Clojure" "https://www.reddit.com/r/clojure/.rss"]]} + :target {:target-type :mastodon + :append-screen-name? false + :signature "#rssbot"} + :resolve-urls? true + :content-filters [".*bannedsite.*"] + :keyword-filters [".*clojure.*"] + :replacements nil} + + {:source {:source-type :tumblr + ;; optional limit for number of posts to retrieve, default: 5 + :limit 10 + :accounts ["cyberpunky.tumblr.com" "scipunk.tumblr.com"]} + :target {:target-type :mastodon + :signature "#tumblrbot"}} + + ]} \ No newline at end of file