aa-killstats 1.0.0

Killboard Stats shows Hall of Shame/Fame, Kills, Top Kills,Loss,etc.

Killstats module for AllianceAuth.

Killstats for Corporations & Alliances, Hall of Fame, Hall of Shame, etc.

-

• AA Killstats
  • Features
  • Upcoming
  • Installation
    • Step 0 - Check dependencies are installed
    • Step 1 - Install the Package
    • Step 2 - Configure Alliance Auth
    • Step 3 - Add the Scheduled Tasks and Settings
    • Step 4 - Migration to AA
    • Step 5 - Setting up Permissions
    • Step 6 - (Optional) Setting up Compatibilies
  • Highlights

Features

• Graphical Overview
• Corporation & Alliance Overview
• Kills/Losses
• Main Character and Alts combined (explanation)
• Hall of Fame, Hall of Shame
• Killstats like Top Kill, Top Killer, Top Loss, Alltime Killer, etc.
• Top 10 list for each Month

Upcoming

• Filtering Settings for each Corporation / Alliance
• Administration Access for specific Corps or Alliances

Installation

[!NOTE] AA Killstats needs at least Alliance Auth v4.6.0 Please make sure to update your Alliance Auth before you install this APP

Step 0 - Check dependencies are installed

• Killstats needs the app django-eveuniverse to function. Please make sure it is installed.

Step 1 - Install the Package

Make sure you're in your virtual environment (venv) of your Alliance Auth then install the pakage.

pip install aa-killstats

Step 2 - Configure Alliance Auth

Configure your Alliance Auth settings (local.py) as follows:

• Add 'killstats', to INSTALLED_APPS

Step 3 - Add the Scheduled Tasks

To set up the Scheduled Tasks add following code to your local.py

CELERYBEAT_SCHEDULE["killstats_run_zkb_redis"] = {
    "task": "killstats.tasks.run_zkb_redis",
    "schedule": crontab(minute="*/1"),
}
KILLSTATS_QUEUE_ID = ""

[!WARNING] Please note that the queue ID must be globally unique for all users of the zKillboard API, so choose carefully. No spaces or special characters allowed. Example

KILLSTATS_QUEUE_ID = "MyGneutenCorporation2000"

Step 3.1 - (Optional) Add own Logger File

To set up the Logger add following code to your local.py Ensure that you have writing permission in logs folder.

LOGGING["handlers"]["killstats_file"] = {
    "level": "DEBUG",
    "class": "logging.handlers.RotatingFileHandler",
    "filename": os.path.join(BASE_DIR, "log/killstats.log"),
    "formatter": "verbose",
    "maxBytes": 1024 * 1024 * 5,
    "backupCount": 5,
}
LOGGING["loggers"]["extensions.killstats"] = {
    "handlers": ["killstats_file"],
    "level": "DEBUG",
}

Step 4 - Migration to AA

python manage.py collectstatic
python manage.py migrate

Step 5 - Setting up Permissions

With the Following IDs you can set up the permissions for the KILLSTATS

ID	Description
basic_access	Can access this app, Killstats.	All Members with the Permission can access the Killstats App.
admin_access	Has access to all killstats.	Has access to all Killstats Views, Can add Corporation/Alliance.

Step 6 - (Optional) Setting up Compatibilies

The Following Settings can be setting up in the local.py

Setting	Configuration(default)	Description
KILLSTATS_APP_NAME	"YOURNAME" ("Killstats")	Set the name of the APP.
KILLBOARD_API_CACHE_LIFETIME	5 (10)	Set Cache Lifetime for Killstats in Minutes.

Highlights

[!NOTE] Contributing You want to improve the project? Just Make a Pull Request with the Guidelines. We Using pre-commit