feediverse


Namefeediverse JSON
Version 0.4.1 PyPI version JSON
download
home_pageNone
SummaryConnect an RSS Feed to Mastodon
upload_time2024-10-10 14:33:56
maintainerNone
docs_urlNone
authorEd Summers
requires_python<4.0,>=3.9
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            *feediverse* will read RSS/Atom feeds and send the messages as Mastodon posts.
It's meant to add a little bit of spice to your timeline from other places.
Please use it responsibly.

## Install

    pip install feediverse

## Run

The first time you run *feediverse* you'll need to tell it your Mastodon
instance and get an access token which it will save in a configuration file. If
you don't specify a config file it will use `~/.feediverse`:

    feediverse

Once *feediverse* is configured you can add it to your crontab:

    */15 * * * * /usr/local/bin/feediverse    

Run `feediverse --help` to show the command line options.

## Post Format

You can customize the post format by opening the configuration file (default is
~/.feediverse) and updating the *template* property of your feed. The default
format is:

    {title} {url}

If you want you can use `{summary}` in your template, and add boilerplate text
like so:

    Bookmark: {title} {url} {summary}

`{hashtags}` will look for tags in the feed entry and turn them into a space
separated list of hashtags. For some feeds (e.g. youtube-rss) you should use `{link}` instead of `{url}`.

`{content}` is the whole content of the feed entry (with html-tags
stripped). Please be aware that this might easily exceed Mastodon's
limit of 512 characters.


## De-duping

If you are attempting to use the RSS feed of a major news site, you may find
that they change / update (or just re-post) the same items multiple times which
will lead to duplicate toots. To enable de-duplication, use the `{--dedupe}`
option to check for duplicates based on a tag before tooting, e.g.

    feediverse --dedupe url

## Multiple Feeds

Since *feeds* is a list you can add additional feeds to watch if you want.

    ...
    feeds:
      - url: https://example.com/feed/
        template: "dot com: {title} {url}"
      - url: https://example.org/feed/
        template: "dot org: {title} {url}"

## Develop

    poetry install
    poetry run feediverse

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "feediverse",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "Ed Summers",
    "author_email": "ehs@pobox.com",
    "download_url": "https://files.pythonhosted.org/packages/0b/c3/04875769ffcc171077bfee0acaa5047664b56fab0b07f814a27ff7e23189/feediverse-0.4.1.tar.gz",
    "platform": null,
    "description": "*feediverse* will read RSS/Atom feeds and send the messages as Mastodon posts.\nIt's meant to add a little bit of spice to your timeline from other places.\nPlease use it responsibly.\n\n## Install\n\n    pip install feediverse\n\n## Run\n\nThe first time you run *feediverse* you'll need to tell it your Mastodon\ninstance and get an access token which it will save in a configuration file. If\nyou don't specify a config file it will use `~/.feediverse`:\n\n    feediverse\n\nOnce *feediverse* is configured you can add it to your crontab:\n\n    */15 * * * * /usr/local/bin/feediverse    \n\nRun `feediverse --help` to show the command line options.\n\n## Post Format\n\nYou can customize the post format by opening the configuration file (default is\n~/.feediverse) and updating the *template* property of your feed. The default\nformat is:\n\n    {title} {url}\n\nIf you want you can use `{summary}` in your template, and add boilerplate text\nlike so:\n\n    Bookmark: {title} {url} {summary}\n\n`{hashtags}` will look for tags in the feed entry and turn them into a space\nseparated list of hashtags. For some feeds (e.g. youtube-rss) you should use `{link}` instead of `{url}`.\n\n`{content}` is the whole content of the feed entry (with html-tags\nstripped). Please be aware that this might easily exceed Mastodon's\nlimit of 512 characters.\n\n\n## De-duping\n\nIf you are attempting to use the RSS feed of a major news site, you may find\nthat they change / update (or just re-post) the same items multiple times which\nwill lead to duplicate toots. To enable de-duplication, use the `{--dedupe}`\noption to check for duplicates based on a tag before tooting, e.g.\n\n    feediverse --dedupe url\n\n## Multiple Feeds\n\nSince *feeds* is a list you can add additional feeds to watch if you want.\n\n    ...\n    feeds:\n      - url: https://example.com/feed/\n        template: \"dot com: {title} {url}\"\n      - url: https://example.org/feed/\n        template: \"dot org: {title} {url}\"\n\n## Develop\n\n    poetry install\n    poetry run feediverse\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Connect an RSS Feed to Mastodon",
    "version": "0.4.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c51aa5fb82fb3b0bdc217ee1dd1ef0050af03117284165bec8cfaf1852bf039c",
                "md5": "aef4c6e6f16937733435e1c2f9c68268",
                "sha256": "5d964e515d925e4bbc5e1cac925aec79d488317756ea6ac0b091f5411eed5091"
            },
            "downloads": -1,
            "filename": "feediverse-0.4.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "aef4c6e6f16937733435e1c2f9c68268",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 5916,
            "upload_time": "2024-10-10T14:33:55",
            "upload_time_iso_8601": "2024-10-10T14:33:55.282387Z",
            "url": "https://files.pythonhosted.org/packages/c5/1a/a5fb82fb3b0bdc217ee1dd1ef0050af03117284165bec8cfaf1852bf039c/feediverse-0.4.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0bc304875769ffcc171077bfee0acaa5047664b56fab0b07f814a27ff7e23189",
                "md5": "2025e453c3b43a9ed74f731b0bb67146",
                "sha256": "bd250537620b137a434a39042c993ace8f385e34f4938ff04d42a71b5019d579"
            },
            "downloads": -1,
            "filename": "feediverse-0.4.1.tar.gz",
            "has_sig": false,
            "md5_digest": "2025e453c3b43a9ed74f731b0bb67146",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 5210,
            "upload_time": "2024-10-10T14:33:56",
            "upload_time_iso_8601": "2024-10-10T14:33:56.248425Z",
            "url": "https://files.pythonhosted.org/packages/0b/c3/04875769ffcc171077bfee0acaa5047664b56fab0b07f814a27ff7e23189/feediverse-0.4.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-10 14:33:56",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "feediverse"
}
        
Elapsed time: 0.30069s