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 Translation status Discord

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 v5 Please make sure to update your Alliance Auth before you install this APP

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:

INSTALLED_APPS = [
    # other apps
    "eve_sde",  # only if it not already existing
    "killstats",
    # other apps?
]

# This line is right below the `INSTALLED_APPS` list, if not already exist!
INSTALLED_APPS = ["modeltranslation"] + INSTALLED_APPS

Step 3 - Add the Scheduled Tasks

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

if "killstats" in INSTALLED_APPS:
    CELERYBEAT_SCHEDULE["Killstats :: Check for Killmails"] = {
        "task": "killstats.tasks.run_zkb_r2z2",
        "schedule": crontab(minute="*/1"),
    }

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 - Migrate & Preload EVE SDE Data

AA Killstats uses EVE SDE data to map IDs to names for EveTypes. You will need to preload some data from SDE once.

python manage.py migrate eve_sde
python manage.py esde_load_sde

Step 4.1 - Migrate App and collect static

Migrate the app and collect static.

python manage.py migrate skillfarm
python manage.py skillfarm_load_prices
python manage.py collectstatic --noinput

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_API_CACHE_LIFETIME 5 (10) Set Cache Lifetime for Killstats in Minutes.

Step 6 - (Optional) Settings

  • KILLSTATS_BULK_BATCH_SIZE: 500 - Maximum database batch size per operation. Reduce (e.g., 250) if encountering 'max_allowed_packet' errors, increase for better performance if MySQL is configured with higher limits

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-3.0.0.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-3.0.0-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aa_killstats-3.0.0.tar.gz
Algorithm Hash digest
SHA256 5779d6b7dd0b90ac528fbc79b43534b94d4c5d82cff90720f23001a4efdf7bdd
MD5 c6353f6cdacf888c1ae3b8ec72720b2e
BLAKE2b-256 af715fc6537908db28520dd819574e52af2ea7e127cb7998702c8ff71bb8cd19

See more details on using hashes here.

Provenance

The following attestation bundles were made for aa_killstats-3.0.0.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-3.0.0-py3-none-any.whl.

File metadata

  • Download URL: aa_killstats-3.0.0-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.12

File hashes

Hashes for aa_killstats-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cbca4c96d8cc783b674ba86baef04b560d3c35569380b91242fd13d0d5625701
MD5 9a0b58fd894927ae8b88b82079f838e0
BLAKE2b-256 858c33df72dce3707db16f95843001196b181c4066ddb3194805568728c2556e

See more details on using hashes here.

Provenance

The following attestation bundles were made for aa_killstats-3.0.0-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