Metadata-Version: 2.1
Name: aa-discordnotify
Version: 0.1.0b1
Summary: Forward Alliance Auth notifications to users on Discord
Home-page: https://gitlab.com/ErikKalkoken/aa-discordnotify
Author: Erik Kalkoken
Author-email: kalkoken87@gmail.com
License: MIT
Description: # Discord Notify
        
        Forward Alliance Auth notifications to users on Discord
        
        [![release](https://img.shields.io/pypi/v/aa-discordnotify?label=release)](https://pypi.org/project/aa-discordnotify/)
        [![python](https://img.shields.io/pypi/pyversions/aa-discordnotify)](https://pypi.org/project/aa-discordnotify/)
        [![django](https://img.shields.io/pypi/djversions/aa-discordnotify?label=django)](https://pypi.org/project/aa-discordnotify/)
        [![pipeline](https://gitlab.com/ErikKalkoken/aa-discordnotify/badges/master/pipeline.svg)](https://gitlab.com/ErikKalkoken/aa-discordnotify/-/pipelines)
        [![codecov](https://codecov.io/gl/ErikKalkoken/aa-discordnotify/branch/master/graph/badge.svg?token=AU1U2LQSUS)](https://codecov.io/gl/ErikKalkoken/aa-discordnotify)
        [![license](https://img.shields.io/badge/license-MIT-green)](https://gitlab.com/ErikKalkoken/aa-discordnotify/-/blob/master/LICENSE)
        [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
        [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
        [![chat](https://img.shields.io/discord/790364535294132234)](https://discord.gg/zmh52wnfvM)
        
        ## Contents
        
        - [Overview](#overview)
        - [Installation](#installation)
        - [Settings](#settings)
        - [Change Log](CHANGELOG.md)
        
        ## Overview
        
        This app automatically forwards Alliance Auth notifications to users on Discord.
        
        ### Features
        
        - Aut notifications appear as DM on Discord
        - Notifications are colored according to level (e.g. INFO = blue)
        - Option to forward superuser's notifications only
        
        ## Example
        
        ![example](https://i.imgur.com/eebZFQj.png)
        
        ## Installation
        
        ### Preconditions
        
        1. Discord Notify 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](https://allianceauth.readthedocs.io/en/latest/installation/auth/allianceauth/) for details)
        
        1. Discord Notify needs [Discord Proxy](https://gitlab.com/ErikKalkoken/discordproxy) to function. Please make sure the server is up and running on your system, before continuing.
        
        1. Please also make sure you have the Discord service enabled in Alliance Auth.
        
        ### Step 1 - Install app
        
        Make sure you are in the virtual environment (venv) of your Alliance Auth installation. Then install the newest release from PyPI:
        
        ```bash
        pip install aa-discordnotify
        ```
        
        ### Step 2a - Configure Auth settings
        
        Configure your Auth settings (`local.py`) as follows:
        
        - Add `"discordnotify"` to `INSTALLED_APPS`
        - Optional: Add additional settings if you want to change any defaults. See [Settings](#settings) for the full list.
        
        ### Step 3 - Finalize App installation
        
        Restart your supervisor services for Auth (no migration required).
        
        Congratulations you are now ready to use Discord Notify!
        
        ## Settings
        
        Here is a list of available settings for this app. They can be configured by adding them to your AA settings file (`local.py`).
        
        Note that all settings are optional and the app will use the documented default settings if they are not used.
        
        Name | Description | Default
        -- | -- | --
        `DISCORDNOTIFY_DISCORDPROXY_PORT`| Port used to communicate with Discord Proxy. | `50051`
        `DISCORDNOTIFY_SUPERUSER_ONLY`| When set to True, only superusers will be get their notifications forwarded. | `False`
        
Platform: UNKNOWN
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.1
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: ~=3.6
Description-Content-Type: text/markdown
