Skip to main content

Alliance Auth module to post news from RSS feeds to your Discord

Project description

Alliance Auth RSS to Discord

Version License Python Django pre-commit Code Style: black Discord

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

Contents

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 function, 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 are in the virtual environment (venv) of your Alliance Auth installation Then install the latest releast directly from PyPi.

pip install aa-rss-to-discord

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
    if "aa_rss_to_discord" in INSTALLED_APPS:
        CELERYBEAT_SCHEDULE["aa_rss_to_discord_fetch_rss"] = {
            "task": "aa_rss_to_discord.tasks.fetch_rss",
            "schedule": crontab(minute="*/5"),
        }
    

Step 3 - Finalize 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.

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 -U aa-rss-to-discord

python manage.py migrate

Finally restart your supervisor services for AA.

Project details


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-0.1.0b1.tar.gz (20.1 kB view hashes)

Uploaded Source

Built Distribution

aa_rss_to_discord-0.1.0b1-py3-none-any.whl (19.8 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page