~cnx/rsskey

RSS feed mirror on Misskey

23a1828 Add basic documentation

~cnx pushed to ~cnx/rsskey git

a month ago

23a1828 Add basic documentation

~cnx pushed to ~cnx/rsskey git

a month ago

#rsskey

rsskey is a simple script for mirroring RSS or Atom feeds on Misskey. It splits original posts into paragraphs or sentences to fit an instance's character limit and checks for previous notes before creating.

#Installation

rsskey depends on feedparser, httpx, loca, markdownify and trio. If you pip install rsskey, pip will install all the dependencies for you to run python -m rsskey.

Alternatively, you can get the requirements from your distribution, fetch the source tree and execute src/rsskey.py.

#Usage

In rsskey's user configuration directory, declare the mirroring jobs in jobs.conf, for example:

[rms@birb.space]
; URL to RSS/Atom feed source
source = https://stallman.org/rss/rss.xml
; URL to destination Misskey instance's API
dest = https://birb.space/api
; Character limit of the Misskey instance
limit = 420
; Misskey user ID for searching previous notes
user = 8rt4sahf1j
; Access token with permission to compose notes
token = 7h4753cur3r4nd0m57r1n61764v3y0u

In order to run rsskey chronically, set up a cron job or something IDK.

#Contributing

Patches should be sent to ~cnx/misc@lists.sr.ht using git send-email with the following configurations:

git config sendemail.to '~cnx/misc@lists.sr.ht'
git config format.subjectPrefix 'PATCH rsskey'

#Copying

AGPLv3

rsskey is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.