Skip to main content

Improved SRP Module for Alliance Auth

Project description

AA-SRP

Version License Python Django pre-commit Code Style: black Discord Checks codecov Contributor Covenant

ko-fi

SRP Module for Alliance Auth

Contents

Overview

Features

  • Overview of SRP links
  • Overview of your own SRP requests and their status
  • Accepting kill mails from zKillboard and EveTools Killboard
  • SRP Request administration mostly done via ajax and without page reloads
  • Use modern DataTables with filters where ever they are useful
  • Tables fully searchable and sortable
  • Mandatory reason on SRP reject
  • Notifications in AA with detailed information on SRP rejection
  • Discord notification via PM to the user on SRP request approval or rejection, if either AA-Discordbot, AA-Discord Notify or Discord Proxy is installed
  • Notify your SRP team (optional) in their Doscord channel about new SRP requests, if AA-Discordbot is installed

Screenshots

Dashboard

AA SRP Dashboard

Dashboard (View All)

AA SRP Dashboard (View All)

Your SRP Requests

Your SRP Requests View

SRP Requests Overview

SRP Requests Overview

SRP Request Details

SRP Request Details

Installation

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

  • AA SRP 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)
  • AA SRP needs the app django-eveuniverse to function. Please make sure it is installed, before continuing.

Step 1 - Install the package

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

pip install aa-srp

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 "eveuniverse", to INSTALLED_APPS
  • Add "aasrp", to INSTALLED_APPS

Step 3 - Finalize the installation

Run static files collection and migrations

python manage.py collectstatic
python manage.py migrate

Restart your supervisor services for Auth

Step 4 - Preload Eve Universe data

AA SRP utilizes the EveUniverse module, so it doesn't need to ask ESI for ship information. To set this up, you now need to run the following command.

python manage.py aasrp_load_eve

Step 5 - Set up permissions

Now it's time to set up access permissions for your new SRP module. You can do so in your admin backend in the AA SRP section. Read the Permissions section for more information about the available permissions.

Step 6 - (Optional) Import from built-in SRP module

This step is only needed when you have been using the built-in SRP module until now.

Make sure you don't have any open SRP requests before. All SRP links in the built-in module will be closed during the import process, to make sure to not import any duplicates.

The import process can be done at any given time and does not necessarily have to be during the installation.

To import your SRP information from the built-in SRP module, run the following command.

python manage.py aasrp_migrate_srp_data

Permissions

ID Description Notes
basic_access Can access the AA-SRP module Your line members should have this permission.
create_srp Can create new SRP links Your FCs should have this permission.
manage_srp Can manage SRP Users with this permission can manage the AA SRP Module. Like changing and removing SRP links and requests.
manage_srp_requests Can manage SRP requests Users with this permission can manage the SRP requests. Like changing and removing SRP requests.

Settings

Key Description Type Default
AASRP_SRP_TEAM_DISCORD_CHANNEL ID of the Discord channel of your SRP team. If set, your SRP team will be notified (no ping to prevent ping spam) about new SRP requests in their channel. (You need to have AA-Discordbot installed and configured to use this option) int None

Changelog

See CHANGELOG.md

Contributing

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)

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

aa_srp-1.15.0.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

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

aa_srp-1.15.0-py3-none-any.whl (1.1 MB view details)

Uploaded Python 3

File details

Details for the file aa_srp-1.15.0.tar.gz.

File metadata

  • Download URL: aa_srp-1.15.0.tar.gz
  • Upload date:
  • Size: 1.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.13

File hashes

Hashes for aa_srp-1.15.0.tar.gz
Algorithm Hash digest
SHA256 8c9ef75f4fd9624424611e832d9df214743ee88aece71a65ca22dff90ce4b14b
MD5 3a3203a79d12e053f1cb337a7e431265
BLAKE2b-256 39cc89068b3255464885cdde1b8588d38d3bfc6ac282bf33fcc2db3829735389

See more details on using hashes here.

File details

Details for the file aa_srp-1.15.0-py3-none-any.whl.

File metadata

  • Download URL: aa_srp-1.15.0-py3-none-any.whl
  • Upload date:
  • Size: 1.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.8.13

File hashes

Hashes for aa_srp-1.15.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f0af74c3d12cc2485f343ece680e517d18b65a2314678eb41ff7a04886b76f4d
MD5 57cdba27060bcbb2583ecd96edbbcd7f
BLAKE2b-256 9830d2253d0f82a470a8858d5d75e059b8bf3495db6dc5b97548582253a9125c

See more details on using hashes here.

Supported by

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