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

  • 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

Stats Hall Kills

Translations

Translations

Help us translate this app into your language or improve existing translations. Join our team!"

Contributing

You want to improve the project? Please ensure you read the contribution guidelines

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-1.0.2.tar.gz (1.2 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-1.0.2-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aa_killstats-1.0.2.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for aa_killstats-1.0.2.tar.gz
Algorithm Hash digest
SHA256 bbe35a2575f6dea07bb0a9ed38e6275ab35a97024669ab96fb00df420549f62f
MD5 a0f72981647a964b8443c11d15cb14f4
BLAKE2b-256 17513cf778d52db71f79497f6da88dfe50f282b645c592efa65e9e9bc78b0e5c

See more details on using hashes here.

Provenance

The following attestation bundles were made for aa_killstats-1.0.2.tar.gz:

Publisher: release.yml on Geuthur/aa-killstats

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

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

File hashes

Hashes for aa_killstats-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7bbc52dd9f69dd00db7ff423076081833bcaeb8d32554925db949bee4e37717a
MD5 00a9f198e903771396aa70620115cfac
BLAKE2b-256 fbeca96bd2a7c6a4707ca31cb8ba7c0b9c591c5406f0b36b26ae64b7c19856ff

See more details on using hashes here.

Provenance

The following attestation bundles were made for aa_killstats-1.0.2-py3-none-any.whl:

Publisher: release.yml on Geuthur/aa-killstats

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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