Skip to main content

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

Project description

Killstats module for AllianceAuth.

pre-commit.ci status Code style: black Tests codecov

ko-fi

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

-

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

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 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.
KILLSTATS_LOGGER_USE True / False (False) Set to use own Logger File.
KILLBOARD_API_CACHE_LIFETIME 5 (10) Set Cache Lifetime for Killstats in Minutes.

If you set up KILLSTATS_LOGGER_USE to True you need to add the following code below:

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

Highlights

Stats Hall Kills

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

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_killstats-0.5.3.tar.gz (1.3 MB view details)

Uploaded Source

Built Distribution

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

aa_killstats-0.5.3-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file aa_killstats-0.5.3.tar.gz.

File metadata

  • Download URL: aa_killstats-0.5.3.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for aa_killstats-0.5.3.tar.gz
Algorithm Hash digest
SHA256 702e0cd76c76018607e86d87e1ffe99bcef379abf2bc4e4252cf843968dd4d06
MD5 9506113be67e8e9a275bdb0b9feb714a
BLAKE2b-256 8cf33244e55a7ad9bb5383435947d4c95023b2d99b68a08d89514beaa183b134

See more details on using hashes here.

File details

Details for the file aa_killstats-0.5.3-py3-none-any.whl.

File metadata

  • Download URL: aa_killstats-0.5.3-py3-none-any.whl
  • Upload date:
  • Size: 1.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for aa_killstats-0.5.3-py3-none-any.whl
Algorithm Hash digest
SHA256 145525cf143a78efbe7f06abd6e5797e12faefc388681882f0a51ce8515e9a96
MD5 c75e282b743788274262c0a1873de33c
BLAKE2b-256 f7dbf6e9b6c2bf5ba87440f0976f91b8c5a8572f3193686a4caddba1fb578b4e

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