Package Health Score

78 / 100

security
No known security issues
popularity
Small
maintenance
Sustainable
community
Active

Popularity

Small

GitHub Stars: 12.9K
Forks: 814
Contributors: 130

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package aa-discordnotify, we found that it has been starred 12,898 times.

Security

No known security issues

Security and license risk for latest version

Release Date: May 10, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

We found a way for you to contribute to the project! Looks like aa-discordnotify is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Sustainable

Commit Frequency

Open Issues: 20
Open PR: 11
Last Release: 6 months ago
Last Commit: 7 days ago

Further analysis of the maintenance status of aa-discordnotify based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Sustainable.

We found that aa-discordnotify demonstrates a positive version release cadence with at least one new version released in the past 12 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Community

Active

Readme: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 130
Funding: Yes

A good and healthy external contribution signal for aa-discordnotify project, which invites more than one hundred open source maintainers to collaborate on the repository.

We found a way for you to contribute to the project! Looks like aa-discordnotify is missing a Code of Conduct.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.8

Age: 4 years
Latest Release: 6 months ago
Dependencies: 0 Direct
Versions: 13
Maintainers: 1
Wheels: OS Independent

Readme

Discord Notify

Forward Alliance Auth notifications to users on Discord

Overview

This app automatically forwards Alliance Auth notifications to users on Discord.

Features

Auth notifications appear instantly as DM on Discord
Notifications are colored according to their level (e.g. INFO = blue)
Can be restricted to notifications for superusers only (e.g. to keep track of errors)

Example

example

Installation

Step 1 - Check preconditions

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 for details)
Discord Notify needs Discord Proxy to function. Please make sure the server is up and running on your system, before continuing.
Please also make sure you have the Discord service installed and setup in Alliance Auth.

Step 2 - Install app

Make sure you are in the virtual environment (venv) of your Alliance Auth installation. Then install the newest release from PyPI:

pip install aa-discordnotify

Step 3 - 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 for the full list.

Step 4 - Finalize App installation

Restart your supervisor services for Auth (no migration required).

Step 5 - Send test notification

To test that your installation was successful you can create a test notification to yourself by navigating to the relative route /discordnotify/test in your browser. The absolute URL depends on your Auth site. Example: For an Auth site with the URL https://auth.example.com the test URL would be:

https://auth.example.com/discordnotify/test

When everything was setup correctly, you will receive a test notification on Discord.

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_ENABLED`	Set this to False to disable this app temporarily	`True`
`DISCORDPROXY_PORT`	Port used to communicate with Discord Proxy.	`50051`
`DISCORDPROXY_HOST`	Hostname used to communicate with Discord Proxy.	`localhost`
`DISCORDNOTIFY_MARK_AS_VIEWED`	When enabled will mark all notifications as viewed that have been successfully submitted to Discord	`False`
`DISCORDNOTIFY_SUPERUSER_ONLY`	When enabled only superusers will be get their notifications forwarded.	`False`

FAQs

What is aa-discordnotify?

Forward Alliance Auth notifications to users on Discord. Visit Snyk Advisor to see a full health score report for aa-discordnotify, including popularity, security, maintenance & community analysis.

Is aa-discordnotify popular?

The python package aa-discordnotify receives a total of 645 weekly downloads. As such, aa-discordnotify popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is aa-discordnotify well maintained?

We found indications that aa-discordnotify maintenance is sustainable demonstrating some project activity. We saw a total of 130 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is aa-discordnotify safe to use?

The python package aa-discordnotify was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 4 November-2024, at 17:52 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

aa-discordnotify

Forward Alliance Auth notifications to users on Discord. For more information about how to use this package see README

Ensure you're using the healthiest python packages

Package Health Score

Popularity

Direct Usage Popularity

Security

Security and license risk for latest version

Maintenance

Commit Frequency

Community

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Package

Readme

Discord Notify

Contents

Overview

Features

Example

Installation

Step 1 - Check preconditions

Step 2 - Install app

Step 3 - Configure Auth settings

Step 4 - Finalize App installation

Step 5 - Send test notification

Settings

FAQs

What is aa-discordnotify?

Is aa-discordnotify popular?

Is aa-discordnotify well maintained?

Is aa-discordnotify safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Fix identified vulnerabilities

Monitor for new issues

Package Health Score

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

Discord Notify

Contents

Overview

Features

Example

Installation

Step 1 - Check preconditions

Step 2 - Install app

Step 3 - Configure Auth settings

Step 4 - Finalize App installation

Step 5 - Send test notification

Settings

FAQs

What is aa-discordnotify?

Is aa-discordnotify popular?

Is aa-discordnotify well maintained?

Is aa-discordnotify safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues