Skip to main content

Alliance Auth RSS to Discord

Version License Python Django pre-commit pre-commit.ci status Code Style: black Checks codecov Badge: Translation Status Contributor Covenant Discord Alliance Auth Compatibility

ko-fi

A simple app to post selected RSS feeds to your Discord.



Installation

Important: Please make sure you meet all preconditions before you proceed:

  • Alliance Auth RSS to Discord is a plugin for Alliance Auth. If you don't have Alliance Auth running already, please install it first before proceeding. (see the official AA installation guide for details)
  • Alliance Auth RSS to Discord needs AA-Discordbot to interact with your Discord server. Make sure it is installed and configured before installing this app.

Step 0.5: Install AA-Discordbot

In order for this app to work, you need to install and configure AA-Discordbot first. Read the instructions how to do so in the README of AA-Discordbot.

Step 1: Install the Package

Make sure you're in the virtual environment (venv) of your Alliance Auth installation Then install the latest release directly from PyPi.

pip install aa-rss-to-discord==3.1.0

Step 2: Configure Alliance Auth

This is fairly simple, just add the following to the INSTALLED_APPS of your local.py

Configure your AA settings (local.py) as follows:

  • Add "aa_rss_to_discord", to INSTALLED_APPS
  • Add the scheduled task
    CELERYBEAT_SCHEDULE["aa_rss_to_discord_fetch_rss"] = {
        "task": "aa_rss_to_discord.tasks.fetch_rss",
        "schedule": crontab(minute="*/5"),
    }
    

Step 3: Finalizing the Installation

Run migrations to finalize the installation

python manage.py migrate

Finally, restart your supervisor services for AA.

Step 4: Configure your RSS Feeds

First, you need to set up the Discord Server and Channels. For this, you go in your admin backend to the Discordbot settings and enter the needed information there.

When done, you can set up your RSS feeds. This can be done in the setting of this app, still in your admin backend. Create a new RSS Feed entry, enter the name, url and select the Discord channel it should be posted to. Once done, save it.

Discord Bot Commands

The following commands are available for the Discord bot to manage RSS/Atom feeds:

Command Options What it does
/rss add <rss_url> <rss_name> rss_url - The URL of the RSS/Atom feed
rss_name - A Name for the RSS/Atom Feed
Adding a RSS/Atom feed to the current channel
/rss delete <rss_feed_id> rss_feed_id - The ID of the RSS/Atom feed you want to remove Remove a RSS/Atom feed from the current Discord channel
/rss disable <rss_feed_id> rss_feed_id - The ID of the RSS/Atom feed you want to disable Disable an enabled RSS/Atom feed for the current Discord channel
/rss enable <rss_feed_id> rss_feed_id - The ID of the RSS/Atom feed you want to enable Enable a disabled RSS/Atom feed for the current Discord channel
/rss list None List all RSS/Atom feeds for the current Discord channel

Updating

To update your existing installation of Alliance Auth RSS to Discord, first enable your virtual environment (venv) of your Alliance Auth installation.

pip install aa-rss-to-discord==3.1.0

python manage.py migrate

Finally, restart your supervisor services for AA.

Changelog

See CHANGELOG.md

Translation Status

Translation status

Do you want to help translate this app into your language or improve the existing translation? - Join our team of translators!

Contributing

Do you want to contribute to this project? That's cool!

Please make sure to read the Contribution Guidelines.
(I promise, it's not much, just some basics)

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aa_rss_to_discord-3.1.0.tar.gz (42.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aa_rss_to_discord-3.1.0-py3-none-any.whl (64.1 kB view details)

Uploaded Python 3

File details

Details for the file aa_rss_to_discord-3.1.0.tar.gz.

File metadata

  • Download URL: aa_rss_to_discord-3.1.0.tar.gz
  • Upload date:
  • Size: 42.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for aa_rss_to_discord-3.1.0.tar.gz
Algorithm Hash digest
SHA256 8728f5793af0a3ef4fc24a5ca89112e61b9854d8a59f998df3e4fd963e97c436
MD5 a5f7ff1ba1a5ba67781b06eeabd5c06b
BLAKE2b-256 57c4348a685b14250f4d9ea30b0f9d3898278a6ff2f4f7cb63af2e563efb08c4

See more details on using hashes here.

Provenance

The following attestation bundles were made for aa_rss_to_discord-3.1.0.tar.gz:

Publisher: release.yml on ppfeufer/aa-rss-to-discord

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file aa_rss_to_discord-3.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aa_rss_to_discord-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8a83e795aa6dd456eb20ebf0f5b0eb047cce1c2e920e9211595870fbbd1e5463
MD5 3b858f8c0dd25733151606bbcfa5102d
BLAKE2b-256 994a05365f253c3a390f46d3284ccc39d8dbca49106cd543c8baba2ffd90fefd

See more details on using hashes here.

Provenance

The following attestation bundles were made for aa_rss_to_discord-3.1.0-py3-none-any.whl:

Publisher: release.yml on ppfeufer/aa-rss-to-discord

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page