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
    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.0b6.tar.gz (21.3 kB view details)

Uploaded Source

Built Distribution

aa_rss_to_discord-0.1.0b6-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

Details for the file aa-rss-to-discord-0.1.0b6.tar.gz.

File metadata

  • Download URL: aa-rss-to-discord-0.1.0b6.tar.gz
  • Upload date:
  • Size: 21.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.2.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.10

File hashes

Hashes for aa-rss-to-discord-0.1.0b6.tar.gz
Algorithm Hash digest
SHA256 e8e9f53218f6822c204f4be3339b5afbdb0dc7441b78f7822bb339b37854a21e
MD5 bec27147aa30f5d2b829da9ecc388cbe
BLAKE2b-256 649c75679606104c595dcebbb6f6c4d0a92a46f40d0c3f81cd58d578888bb54e

See more details on using hashes here.

File details

Details for the file aa_rss_to_discord-0.1.0b6-py3-none-any.whl.

File metadata

  • Download URL: aa_rss_to_discord-0.1.0b6-py3-none-any.whl
  • Upload date:
  • Size: 21.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.2.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.8.10

File hashes

Hashes for aa_rss_to_discord-0.1.0b6-py3-none-any.whl
Algorithm Hash digest
SHA256 46bb9b1592bdca5b4f4489e6eed0510dd83457ae5deb7ef8cb32989ab60496d7
MD5 d45789f589df6bfc65becedc48d9f3f9
BLAKE2b-256 b8a1b5aebca6021fa4825547761bd9ee8633270dd147c6758834448bd92cf2f4

See more details on using hashes here.

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